代码规范服务

一个通过MCP协议为IDE提供团队编码规范的标准服务器,支持自动规则获取、智能缓存和安全认证。

  • by Azteron
  • JavaScript
  • 本地部署
  • 更新于
在 GitHub 查看 Azteron/codesona-mcp-server

使用说明

Codesona MCP服务器

一个标准的MCP服务器,通过stdio传输提供团队编码标准。该服务器连接到Codesona API,并将您团队的编码规则提供给IDE中的AI助手,如Cursor、Windsurf和其他MCP兼容工具。

特性

  • 🔄 从集中式Codesona API自动获取规则
  • 📦 智能缓存(5分钟缓存)
  • ⚡ 快速轻量级的Node.js实现
  • 🔐 安全的API密钥身份验证
  • 📊 完全符合MCP协议

安装

先决条件

方法1:使用npx(推荐-无需安装)

这是最简单的方法。无需全局安装。

  1. 获取API密钥 来自Codesona仪表板

  2. 配置IDE (请参阅下面的IDE特定说明)

方法2:全球安装

全局安装软件包以实现全系统访问:

npm install -g @codesona/mcp-server

安装后,使用配置IDE codesona-mcp-server 命令。

方法3:来源

  1. 克隆存储库
git clone https://dev.azure.com/Azteron/Codesona/_git/CodesonaMCPServer
cd CodesonaMCPServer
  1. 安装依赖项
npm install
  1. 使其可执行 (仅限Unix/Mac)
chmod +x index.js
  1. 配置IDE 使用完整路径 index.js

配置

环境变量

  • CODESONA_API_KEY (必需):您的工作区API键来自Codesona仪表板
  • CODESONA_API_URL (可选):Codesona API URL(默认值: https:/codesona.ai)
  • NODE_ENV (可选):环境模式(开发/生产)

IDE设置说明

光标

  1. 打开光标设置

    • 雨衣: Cmd + , 或 Code > Settings
    • Windows/Linux: Ctrl + , 或 File > Preferences > Settings
  2. 查找MCP设置

    • 在设置搜索栏中搜索“MCP”
    • 或导航到:扩展>MCP
  3. 编辑MCP配置

    • 点击“在settings.json中编辑”
    • 添加以下配置:

    使用npx(推荐):

{
  "mcpServers": {
    "codesona": {
      "command": "npx",
      "args": ["-y", "@codesona/mcp-server"],
      "env": {
        "CODESONA_API_KEY": "your-workspace-api-key-here"
      }
    }
  }
}

使用全局安装:

{
  "mcpServers": {
    "codesona": {
      "command": "codesona-mcp-server",
      "env": {
        "CODESONA_API_KEY": "your-workspace-api-key-here"
      }
    }
  }
}
  1. 更换API键

    • 改变 your-workspace-api-key-here 从Codesona仪表板到您的实际API密钥
  2. 保存并重新启动游标

    • 保存文件(Cmd+S / Ctrl+S)
    • 完全重新启动Cursor (不仅仅是重新加载窗口)

帆板运动

  1. 打开风帆设置

    • 导航到“设置”
  2. 查找MCP配置

    • 查找MCP服务器设置
    • 点击“配置MCP服务器”
  3. 添加Codesona服务器

    使用npx(推荐):

{
  "mcpServers": {
    "codesona": {
      "command": "npx",
      "args": ["-y", "@codesona/mcp-server"],
      "env": {
        "CODESONA_API_KEY": "your-workspace-api-key-here"
      }
    }
  }
}

使用全局安装:

{
  "mcpServers": {
    "codesona": {
      "command": "codesona-mcp-server",
      "env": {
        "CODESONA_API_KEY": "your-workspace-api-key-here"
      }
    }
  }
}
  1. 更换API键 并保存

  2. 重新启动Windsurf

克劳德桌面

  1. 打开Claude桌面配置

    • 雨衣: ~/Library/Application Support/Claude/claude_desktop_config.json
    • 窗户: %APPDATA%\Claude\claude_desktop_config.json
  2. 添加MCP服务器配置

    使用npx(推荐):

{
  "mcpServers": {
    "codesona": {
      "command": "npx",
      "args": ["-y", "@codesona/mcp-server"],
      "env": {
        "CODESONA_API_KEY": "your-workspace-api-key-here"
      }
    }
  }
}

使用全局安装:

{
  "mcpServers": {
    "codesona": {
      "command": "codesona-mcp-server",
      "env": {
        "CODESONA_API_KEY": "your-workspace-api-key-here"
      }
    }
  }
}
  1. 更换API键 并保存

  2. 重新启动克劳德桌面

可用的MCP工具

get_coding_rules

检索强制性团队编码标准。接受可选 codeContext 参数:

  • language:编程语言(例如“csharp”、“javascript”)
  • framework:框架名称(例如“aspnet”、“react”)
  • platform:平台类型(例如,“后端”、“前端”)

规则将缓存5分钟。

suggest_new_rule

为团队标准提出新的编码规则。所需参数: title, description, rationale.可选: exampleCode, badExampleCode, goodExampleCode, codeContext.

可用MCP资源

  • 团队编码标准 (codesona://standards/team):适用于所有项目的团队范围规则

可用MCP提示

  • apply-coding-standards:通过即时采样将团队编码标准应用于对话

故障排除

服务器无法启动:

  • 验证 CODESONA_API_KEY 设置正确
  • 检查Node.js版本是否为18.0.0或更高版本
  • 确保API密钥有效

无效的API密钥:

  • 从Codesona仪表板获取新的API密钥
  • 验证密钥是否具有正确的权限

规则未更新:

  • 规则缓存5分钟
  • 等待缓存到期或检查Codesona API以获取更新

IDE无法连接:

  • 验证Node.js是否在PATH中
  • 检查环境变量是否设置正确
  • 查看IDE日志以了解详细的错误消息

发展

地方发展设置

  1. 安装依赖项
npm install
  1. 设置环境变量
export CODESONA_API_KEY=your-api-key-here
export CODESONA_API_URL=https://codesona.ai
export NODE_ENV=development
  1. 运行服务器
node index.js

许可证

麻省理工学院

支持

对于问题或疑问: