使用说明

项目简介

Code Research Server 是一个基于 Model Context Protocol (MCP) 的服务器实现,旨在为大型语言模型(LLM)提供便捷的代码和编程资源搜索能力。通过集成Stack Overflow、MDN Web Docs、GitHub、npm和PyPI等多个开发者常用平台,该服务器提供了一系列工具,使LLM能够快速检索并利用各种编程相关的上下文信息。

主要功能点

  • 集成多平台: 支持 Stack Overflow, MDN Web Docs, GitHub, npm, PyPI 五大平台的数据搜索。
  • 提供多种搜索工具:
    • 'search_stackoverflow': 搜索 Stack Overflow 问答。
    • 'search_mdn': 搜索 MDN Web Docs 文档。
    • 'search_github': 搜索 GitHub 代码仓库和代码。
    • 'search_npm': 搜索 npm 包。
    • 'search_pypi': 搜索 PyPI 包。
    • 'search_all': 同时搜索所有平台。
  • 缓存机制: 搜索结果会被缓存一段时间,提高响应速度并减少API调用频率。
  • 错误处理: 具备完善的错误处理机制,包括API错误、速率限制等。
  • 开发调试工具: 提供 MCP Inspector 用于请求/响应监控和调试。

安装步骤

  1. 克隆仓库并安装依赖:
    git clone https://github.com/nahmanmate/code-research-mcp-server.git
    cd code-research-mcp-server
    npm install
  2. 构建服务器:
    npm run build

服务器配置

MCP 服务器需要配置到 MCP 客户端中才能使用。以 Claude Desktop 为例,你需要编辑 MCP 配置文件('claude_desktop_config.json'),添加如下服务器配置信息。请根据你的实际代码仓库路径修改 'args' 中的路径。

{
  "mcpServers": {
    "code-research": {  // 服务器名称,可以自定义
      "command": "node",  // 启动服务器的命令,这里使用 node
      "args": ["/absolute/path/to/code-research-mcp-server/build/index.js"], // 服务器启动参数,指向构建后的 index.js 文件,请替换为你的实际路径
      "env": {
        "GITHUB_TOKEN": "your_github_token"  // 可选:GitHub Personal Access Token,用于提高 API 速率限制,没有可以不填
      },
      "disabled": false,  // 设置为 false 启用该服务器
      "alwaysAllow": []   // 允许始终访问的工具,默认为空
    }
  }
}

注意:

  • 请将 '/absolute/path/to/code-research-mcp-server' 替换为你克隆仓库的实际绝对路径。
  • 'GITHUB_TOKEN' 是可选的,如果需要更高的 GitHub API 调用频率,请在 GitHub 开发者设置中创建 Personal Access Token 并填入。

基本使用方法

配置完成后,在支持 MCP 协议的客户端(如 Claude Desktop)中,你可以通过工具调用来使用 Code Research Server 提供的搜索功能。例如,在 Claude 中,你可以这样提问:

'使用 search_stackoverflow 工具搜索 "typescript array filter undefined"'

客户端会将你的请求转换为 MCP 协议的 'CallToolRequest' 发送给 Code Research Server。服务器执行搜索后,会将结果以 MCP 协议的 'CallToolResponse' 返回给客户端,客户端即可将搜索结果展示给你。

你可以根据需要调用不同的工具,并使用工具对应的参数进行更精确的搜索。具体工具和参数请参考上面的“主要功能点”描述或仓库的 README 文档。

信息

分类

开发者工具