使用说明

项目简介

dspy-docs-server 是一个基于 Model Context Protocol (MCP) 的服务器实现，专注于为大型语言模型 (LLM) 应用提供关于 DSPy 库的文档和软件包信息。它通过 MCP 协议与客户端通信，提供名为 'get_dspy_docs' 的工具，允许客户端请求并获取 DSPy 库的各种文档内容，例如 README 文件、示例代码和 API 文档等。

主要功能点

文档检索: 提供 'get_dspy_docs' 工具，用于检索 DSPy 库的文档内容。
多 सेक्शन 支持: 支持获取 DSPy 库的 README, examples, api 等不同 सेक्शन 的文档。
信息聚合: 返回结果包含 DSPy 软件包的 PyPI 信息（如版本、作者、描述等）以及 Markdown 格式转换为纯文本的文档内容。
标准 MCP 协议: 遵循 MCP 协议标准，易于与任何兼容 MCP 协议的客户端集成。

安装步骤

安装 Node.js 和 npm: 确保你的系统中已安装 Node.js 运行时环境和 npm 包管理器。

克隆仓库: 克隆 'mcp-bot' GitHub 仓库到本地：

git clone https://github.com/jmanhype/mcp-bot.git

进入目录: 导航到 'dspy-docs-server' 服务器代码所在的目录：

cd mcp-bot/MCP/dspy-docs-server

安装依赖: 使用 npm 安装项目依赖：
```
npm install
```
配置环境变量: 设置 GitHub API Token 环境变量 'GITHUB_TOKEN'。你需要一个 GitHub Personal Access Token，并赋予 'public_repo' 权限。将 Token 设置为环境变量：
```
export GITHUB_TOKEN=YOUR_GITHUB_TOKEN
```
或者在 '.env' 文件中添加 'GITHUB_TOKEN=YOUR_GITHUB_TOKEN'。

服务器配置

MCP 服务器需要配置启动命令及其参数，以便 MCP 客户端连接和使用。以下是 dspy-docs-server 的配置信息示例（JSON 格式）：

{
  "serverName": "dspy-docs",  // MCP 服务器名称，客户端用于识别和管理
  "command": "node",         // 启动服务器的命令，这里使用 node 解释器
  "args": [                   // 命令参数，指向服务器入口文件
    "/path/to/mcp-bot/MCP/dspy-docs-server/build/index.js"
  ]
}

注意:

请将 '/path/to/mcp-bot' 替换为实际的 'mcp-bot' 仓库在您本地文件系统中的路径。
'serverName' 可以自定义，客户端通过此名称引用该服务器。
客户端需要根据此配置信息启动 dspy-docs-server 进程，并与之建立 MCP 连接。

基本使用方法

启动服务器: 在 'mcp-bot/MCP/dspy-docs-server' 目录下，运行以下命令启动 dspy-docs-server：
```
npm start
```
服务器成功启动后，会在控制台输出 "DSPy Docs MCP server running on stdio"。
客户端调用: MCP 客户端（例如 'mcp-bot' 中的 Slack 机器人）需要配置上述服务器信息，并使用 MCP 协议与 dspy-docs-server 通信。客户端可以通过 'tools/list' 请求获取服务器提供的工具列表，然后使用 'tools/call' 请求调用 'get_dspy_docs' 工具，并传递相应的参数（例如，指定要获取的文档 सेक्शन，如 "README", "examples", "api"）。

工具调用示例 (get_dspy_docs): 客户端调用 'get_dspy_docs' 工具时，可以传递以下参数：

{
  "section": "README" // 可选，指定文档 सेक्शन，可选值: "README", "examples", "api"
}

服务器会返回包含 DSPy 包信息和请求文档内容的 JSON 响应。

关键词