使用说明

项目简介

Expert Server 是一个实现了 Model Context Protocol (MCP) 的服务器，它利用 Anthropic 的 Claude AI 模型，为用户提供 API 文档的智能助手。该服务器集成了两个核心工具：'create-query' 用于根据自然语言生成 API 查询语句，'documentation' 用于从 API 文档中检索相关信息，旨在简化 API 的使用和理解过程。

主要功能点

API 文档查询: 通过自然语言提问，快速从 API 文档中找到所需信息。
智能查询生成: 根据自然语言描述，自动生成符合 API 规范的查询语句。
Claude AI 支持: 利用先进的 Claude AI 模型，提供高质量的自然语言处理能力。
MCP 协议标准: 遵循 Model Context Protocol 标准，易于与 MCP 客户端集成。
可配置性: 允许用户自定义系统提示和工具描述，以适应不同的 API 文档和使用场景。

安装步骤

克隆仓库

git clone https://github.com/crazyrabbitLTC/mcp-expert-server.git
cd mcp-expert-server

安装依赖 确保已安装 Node.js (>= 18)。运行以下命令安装项目依赖：
```
npm install
```
配置 Anthropic API 密钥 在项目根目录下创建 '.env' 文件，并添加您的 Anthropic API 密钥：
```
ANTHROPIC_API_KEY=YOUR_ANTHROPIC_API_KEY
```
请将 'YOUR_ANTHROPIC_API_KEY' 替换为您的实际 API 密钥。
项目设置 运行以下命令构建项目并进行初始化设置：
```
npm run build
npm run setup
```
此命令将创建必要的目录 ('docs/' 和 'prompts/')，生成默认提示文件，并生成初始服务描述。
添加 API 文档 将您的 API 文档文件（支持 '.txt', '.md', '.json' 格式）添加到 'docs/' 目录下。
（可选）自定义提示 您可以根据需要自定义 'prompts/' 目录下的提示文件，例如 'system-prompt.txt' (系统提示), 'tool-metadata.txt' (工具描述元数据), 'query-metadata.txt' (查询元数据) 和 'service-description.txt' (服务描述)。

服务器配置

以下 JSON 配置信息用于 MCP 客户端连接 Expert Server。您需要将此配置添加到您的 MCP 客户端配置中。

{
  "mcpServers": {
    "expert": {  // 服务名称，可以自定义
      "command": "node",  // 启动服务器的命令，这里使用 node
      "args": ["/ABSOLUTE/PATH/TO/expert-server/build/index.js"], // 启动命令的参数，指向服务器入口文件。请将 "/ABSOLUTE/PATH/TO/expert-server" 替换为仓库的绝对路径
      "env": {
        "ANTHROPIC_API_KEY": "YOUR_ANTHROPIC_API_KEY" // 环境变量，用于传递 Anthropic API 密钥。请将 "YOUR_ANTHROPIC_API_KEY" 替换为您的实际 API 密钥，或者确保在运行环境中已设置 ANTHROPIC_API_KEY 环境变量
      }
    }
  }
}

基本使用方法

启动服务器 在项目根目录下运行以下命令启动 Expert Server：
```
npm start
```
服务器默认通过标准输入/输出 (stdio) 与 MCP 客户端通信。

使用工具 Expert Server 提供了 'create-query' 和 'documentation' 两个工具。MCP 客户端可以通过 JSON-RPC 请求调用这些工具。

create-query 工具示例: 生成 API 查询语句

{
  "name": "create-query",
  "arguments": {
    "request": "查找最近一周注册的所有用户"  // 自然语言请求
  }
}

documentation 工具示例: 查询 API 文档信息

{
  "name": "documentation",
  "arguments": {
    "request": "API 请求如何进行身份验证？"  // 自然语言问题
  }
}

请参考 MCP 客户端的文档，了解如何发送 JSON-RPC 请求并与 Expert Server 进行交互。

关键词

使用说明

信息