README
🚀 代码注册表MCP服务器
代码注册表为企业领导者提供企业级代码智能服务。现在配备了原生的、功能齐全的MCP服务器,供AI智能体使用。可直接从Claude桌面版、Claude API和其他MCP兼容客户端对代码库进行尽职调查、技术债务、安全漏洞、代码质量等方面的分析。
🚀 快速开始
作为MCP服务器安装
在配置任何MCP兼容客户端时,请使用以下URL:
https://integrator.app.thecoderegistry.com/api/ai/router
作为智能体技能安装
一些MCP客户端和编辑器(包括Cursor)需要先配置MCP服务器,智能体技能才能使用工具。
Cursor MCP服务器配置(示例)
{
"mcpServers": {
"coderegistry": {
"url": "https://integrator.app.thecoderegistry.com/api/ai/router"
}
}
}
请在Cursor MCP设置中使用此JSON,或者从 integrations/cursor/config.json 复制相同的示例。
Cursor / CallMcpTool 已知限制及解决方法
一些Cursor版本(以及其他将MCP工具封装在通用 CallMcpTool 后面的客户端)可能会显示不完整的工具模式,省略了 arguments,尽管运行时接受该参数。
对于代码注册表工具,在使用 CallMcpTool 时,始终在 arguments 字段中传递所需参数。
通常可以解决此问题的提示语:
使用带有arguments字段的CallMcpTool传递所需参数。
示例调用格式:
{
"server": "coderegistry",
"toolName": "create_project",
"arguments": {
"user_id": "<user_id>",
"name": "My Project"
}
}
然后安装技能:
npx skills add The-Code-Registry/mcp-server
code-registry 技能为您的客户端AI智能体提供额外的上下文和正确使用此MCP服务器的说明,包括:
- 推荐的工具使用流程(
create_account->create_project->create-code-vault-> 轮询) - 首次分析与重新分析的完成规则(快照报告与比较报告)
- 重试/退避行为以及LOCAL_AGENT后续指导
✨ 主要特性
- 零设置:智能体可以自动创建账户,您只需要提供用户的电子邮件地址、姓名和团队/公司名称。
- 隐私至上:使用LOCAL_AGENT代码源类型可将代码保留在本地机器上,仅发送匿名的结果压缩文件。
- 全面分析:涵盖安全性、复杂性、语言、文件类型、代码质量、许可证、技术债务等多个方面。
- 高管友好型报告:分析完成后,包含结果的PDF报告会自动通过电子邮件发送给用户,方便非技术人员查看。
- 多数据源支持:支持本地代码仓库或文件夹、GIT仓库或文件存档。
📦 安装指南
作为MCP服务器安装
在配置任何MCP兼容客户端时,请使用以下URL:
https://integrator.app.thecoderegistry.com/api/ai/router
作为智能体技能安装
一些MCP客户端和编辑器(包括Cursor)需要先配置MCP服务器,智能体技能才能使用工具。
Cursor MCP服务器配置(示例)
{
"mcpServers": {
"coderegistry": {
"url": "https://integrator.app.thecoderegistry.com/api/ai/router"
}
}
}
请在Cursor MCP设置中使用此JSON,或者从 integrations/cursor/config.json 复制相同的示例。
Cursor / CallMcpTool 已知限制及解决方法
一些Cursor版本(以及其他将MCP工具封装在通用 CallMcpTool 后面的客户端)可能会显示不完整的工具模式,省略了 arguments,尽管运行时接受该参数。
对于代码注册表工具,在使用 CallMcpTool 时,始终在 arguments 字段中传递所需参数。
通常可以解决此问题的提示语:
使用带有arguments字段的CallMcpTool传递所需参数。
示例调用格式:
{
"server": "coderegistry",
"toolName": "create_project",
"arguments": {
"user_id": "<user_id>",
"name": "My Project"
}
}
然后安装技能:
npx skills add The-Code-Registry/mcp-server
💻 使用示例
基础用法
MCP协议快速开始
0) 初始化(推荐)
{
"jsonrpc": "2.0",
"method": "initialize",
"params": {
"protocolVersion": "2024-11-05",
"capabilities": {}
},
"id": 1
}
1) 创建账户
{
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"name": "create_account",
"arguments": {
"email": "user@example.com",
"name": "User Name",
"team_name": "Example Org",
"integrator_id": "agent-name"
}
},
"id": 2
}
响应:返回 api_key、team_id 和 user_id(在 result.content[0].text 中以JSON格式呈现) - 请安全存储API密钥,并在所有后续请求中通过 X-API-Key 头信息包含该密钥。
2) 创建项目
{
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"name": "create_project",
"arguments": {
"user_id": "<user_id>",
"name": "My Project",
"description": "Optional"
}
},
"id": 3
}
3) 创建代码库(推荐:LOCAL_AGENT)
{
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"name": "create-code-vault",
"arguments": {
"project_id": "<project_id>",
"user_id": "<user_id>",
"name": "My Code Vault",
"source_type": "LOCAL_AGENT"
}
},
"id": 4
}
响应:包含 next_steps.commands,其中包含需要在本地运行的Docker命令。
4) 轮询结果
{
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"name": "get-code-vault-results",
"arguments": { "vault_id": "<vault_id>" }
},
"id": 5
}
注意:根据代码库大小,结果通常在30分钟到几小时内准备好。请使用指数退避算法进行轮询。
5) 获取报告URL
{
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"name": "get-code-vault-reports",
"arguments": { "vault_id": "<vault_id>" }
},
"id": 6
}
注意:分析完成后会生成PDF报告,并自动通过电子邮件发送给用户。
高级用法
重新分析现有代码库
要对现有代码库重新运行分析:
- 调用
reanalyze-code-vault - 如果原始源类型是
LOCAL_AGENT,则再次运行LOCAL_AGENT - 像往常一样轮询相同的摘要/结果/报告工具
重要:重新分析开始后,get-code-vault-summary、get-code-vault-results 和 get-code-vault-reports 仅返回 新版本 的结果。以前版本的数据无法再通过这些工具访问。
📚 详细文档
入门指南
docs/getting-started.md - 分步指南
API参考
docs/api-reference.md - 完整的操作参考
认证
docs/authentication.md - API密钥管理
分析维度术语表
docs/facets.md - 结果中分析维度的定义
故障排除
docs/troubleshooting.md - 常见问题及解决方案
架构
docs/architecture.md - 系统设计概述
技能指南
skills/README.md - 安装和使用代码注册表智能体技能
🔧 技术细节
MCP协议支持
此服务器支持完整的MCP JSON-RPC 2.0流程,包括:
initializetools/listtools/callresources/list和resources/readprompts/list和prompts/get
先决条件
- 一个MCP兼容客户端(Claude桌面版、Claude代码版或自定义实现)
- 对于LOCAL_AGENT:本地机器上安装了Docker
- 对于GIT源:具有适当访问权限的Git仓库URL
- 对代码分析和软件指标有基本了解
现有账户
如果用户已经有代码注册表账户,他们可以在Web应用程序中生成API密钥,并通过 X-API-Key 头信息直接使用(推荐)。如果MCP客户端无法设置自定义头信息,则可以在工具参数中传递 api_key。
📄 许可证
详情请参阅 LICENSE 文件。
🔗 支持与贡献
支持
- 电子邮件:support@thecoderegistry.com
- 问题反馈:使用GitHub Issues进行bug报告和功能请求
- 网站:thecoderegistry.com
贡献
我们欢迎贡献!请参阅 CONTRIBUTING.md 获取贡献指南。
由 代码注册表 用心打造
全球首个为企业领导者打造的代码智能平台
微信扫一扫