README
🚀 Nia 代码库 MCP 服务器
Nia 代码库 MCP 服务器支持您借助工具(像 Cursor、Claude Desktop 以及其他与 MCP 兼容的客户端)的功能调用,集成 Nia 的代码库理解能力。
🚀 快速开始
Nia 代码库 MCP 服务器允许您通过工具(如 Cursor、Claude Desktop 和其他与 MCP 兼容的客户端)中的功能调用来集成 Nia 的代码库理解能力。
📦 安装指南
无需安装即可使用此 MCP 服务器,使用 npx:
npx -y nia-codebase-mcp@1.0.1 --api-key=YOUR_NIA_API_KEY --transport=stdio
✨ 主要特性
传输选项
Nia 代码库 MCP 服务器支持两种传输方法:
1. 标准输入/输出(stdio)- 默认
这是默认的传输方法,在未指定传输时使用:
npx -y nia-codebase-mcp --api-key=YOUR_NIA_API_KEY
2. 服务器发送事件(SSE)
要使用 SSE 传输,请指定 --transport=sse 标志,可选端口(默认为 3000):
npx -y nia-codebase-mcp --api-key=YOUR_NIA_API_KEY --transport=sse --port=3000
💻 使用示例
在 MCP 客户端中的使用
Cursor
- 打开“Cursor 设置”>“功能”>“MCP 服务器”
- 添加一个新的 MCP 服务器
- 名称:
nia-codebase - 类型:
command - 命令:
npx -y nia-codebase-mcp@1.0.1 --api-key=YOUR_NIA_API_KEY
Claude Desktop
添加到您的 Claude Desktop 配置中,位于 ~/Library/Application Support/Claude/claude_desktop_config.json:
{
"mcpServers": {
"nia-codebase": {
"command": "npx",
"args": ["-y", "nia-codebase-mcp@1.0.1", "--api-key=YOUR_NIA_API_KEY"]
}
}
}
对于 Windows 用户,配置位于 %APPDATA%\Claude\claude_desktop_config.json。
示例提示
使用 lookup_codebase_context 工具,请分析我的项目结构并告诉我主要组件是什么。
使用 lookup_codebase_context 工具,搜索代码库以了解身份验证系统的工作原理及其关键组件。
调试
如果服务器运行不正常,可以启用调试模式:
npx -y nia-codebase-mcp@1.0.1 --api-key=YOUR_NIA_API_KEY --debug=true
环境变量
您也可以使用环境变量配置服务器:
NIA_API_KEY:您的 Nia API 密钥TRANSPORT:要使用的传输方法(stdio或sse)PORT:SSE 传输使用的端口(默认:3000)TOOL_TIMEOUT_MS:工具执行的自定义超时时间(默认:300000ms)DEBUG:启用调试模式(true或false)
工具
此 MCP 服务器提供以下工具:
- lookup_codebase_context:从 Nia 中索引的代码库中查找上下文,根据用户查询检索相关代码片段。
📚 详细文档
要求
- Node.js 18 或更高版本
- 有效的 Nia API 密钥
- 已在 Nia 中索引的代码库
📄 许可证
MIT
Scan to contact