使用说明

项目简介

本项目是一个基于 Model Context Protocol (MCP) 的服务器,旨在为大型语言模型 (LLM) 提供检索 Python 文档的功能。它通过提供 'get_python_docs' 工具,允许 LLM 客户端查询并获取 Python 相关的文档链接,从而扩展 LLM 的知识库和功能。

主要功能点

  • Python 文档检索工具 (get_python_docs)
    • 允许 LLM 客户端通过关键词查询 Python 文档。
    • 使用 Brave Search API 获取相关的文档链接。
    • 返回包含搜索结果的文本信息给 LLM 客户端。

安装步骤

  1. 环境准备:确保已安装 Node.js 和 npm (Node.js 包管理器)。
  2. 下载代码:从 GitHub 仓库克隆代码到本地:
    git clone https://github.com/AnuragRai017/python-docs-server-MCP-Server.git
    cd python-docs-server-MCP-Server
  3. 安装依赖:在项目根目录下运行以下命令安装项目依赖:
    npm install
  4. 构建服务器:运行以下命令构建服务器代码:
    npm run build
    构建成功后,会在 'build' 目录下生成服务器的可执行文件 'index.js'。

服务器配置

要将此 MCP 服务器与 Claude Desktop 等 MCP 客户端配合使用,您需要配置客户端的服务器配置文件。以 Claude Desktop 为例,您需要编辑 'claude_desktop_config.json' 文件,并添加以下配置 (请根据您的实际路径修改 'command' 字段):

MacOS: '~/Library/Application Support/Claude/claude_desktop_config.json' Windows: '%APPDATA%/Claude/claude_desktop_config.json'

{
  "mcpServers": {
    "python-docs-server": {
      "command": "/path/to/python-docs-server/build/index.js" // 请替换为 python-docs-server 项目 build 目录下 index.js 文件的实际路径
    }
  }
}

配置说明:

  • '"python-docs-server"': MCP 服务器的名称,客户端使用此名称来识别和调用该服务器。
  • '"command"': 服务器的启动命令,指向构建后的 'index.js' 文件。请务必替换为实际的文件路径。

基本使用方法

  1. 启动 MCP 服务器: 在项目根目录下,运行以下命令启动服务器 (开发模式,方便调试):

    npm run watch

    或者,您也可以直接运行构建后的 'index.js' 文件 (生产模式):

    node build/index.js

    启动成功后,服务器将在控制台输出 "Python docs MCP server running on stdio"。

  2. 配置 MCP 客户端: 根据 MCP 客户端 (如 Claude Desktop) 的文档,配置并连接到名为 '"python-docs-server"' 的 MCP 服务器。客户端会读取您在 'claude_desktop_config.json' 中配置的服务器信息。

  3. 在 LLM 中使用工具: 连接成功后,您可以在 LLM 客户端中指示 LLM 调用 'get_python_docs' 工具来检索 Python 文档。例如,您可以向 LLM 发出指令,要求其查找关于 "python list" 的文档。LLM 客户端会通过 MCP 协议调用服务器的 'get_python_docs' 工具,并将用户查询 "python list" 作为参数传递给服务器。

  4. 获取搜索结果: MCP 服务器接收到请求后,会调用 Brave Search API 搜索 "python documentation python list",并将搜索结果返回给 LLM 客户端。LLM 客户端即可根据返回的文档链接信息进行后续处理,例如展示给用户或用于生成更详细的回答。

调试

如果需要调试 MCP 服务器,可以使用仓库 README 中推荐的 MCP Inspector 工具,通过运行 'npm run inspector' 启动 Inspector,并根据提示在浏览器中打开调试页面。

信息

分类

网页与API