Unichat MCP 服务器

项目简介

Unichat MCP 服务器是一个基于 Model Context Protocol (MCP) 构建的应用后端,它充当大语言模型客户端(如 Claude Desktop)与 Unichat API 之间的桥梁。该服务器允许您通过标准化的 MCP 协议,利用预定义的 Prompt 模板和工具,便捷地调用 OpenAI, MistralAI, Anthropic, xAI, Google AI 等多种大语言模型,进行代码审查、代码文档生成、代码解释和代码重构等任务。您需要提供相应的 Vendor API Key 才能使用此服务器。

主要功能点

  • 工具 (Tools):
    • 'unichat': 向 Unichat 支持的大语言模型发送请求,进行对话交互。
  • Prompt 模板 (Prompts):
    • 'code_review': 代码审查,检查最佳实践、潜在问题和改进点。
    • 'document_code': 为代码生成文档,包括文档字符串和注释。
    • 'explain_code': 详细解释代码的工作原理。
    • 'code_rework': 根据用户指令修改和重构代码。
  • 传输协议: 支持 STDIO 和 SSE 两种传输协议,可以根据需要选择。

安装步骤

  1. 安装 Node.js 和 npm: 确保您的系统已安装 Node.js 和 npm (Node.js 包管理器)。
  2. 克隆仓库: 将仓库 'amidabuddha_unichat-ts-mcp-server' 克隆到本地。
    git clone https://github.com/MCP-Mirror/amidabuddha_unichat-ts-mcp-server
    cd amidabuddha_unichat-ts-mcp-server
  3. 安装依赖: 在仓库根目录下运行以下命令安装项目依赖。
    npm install
  4. 构建项目: 运行以下命令构建 TypeScript 代码。
    npm run build

服务器配置

要将 Unichat MCP 服务器配置为 MCP 客户端(例如 Claude Desktop)可连接的服务器,您需要编辑 MCP 客户端的配置文件。以下是配置示例,以 JSON 格式提供:

运行本地构建版本 (适用于开发):

{
  "mcpServers": {
    "unichat-ts-mcp-server": {
      "command": "node",
      "args": [
        "{{/path/to}}/unichat-ts-mcp-server/build/index.js"  // 将 {{/path/to}} 替换为您的本地仓库路径
      ],
      "env": {
        "UNICHAT_MODEL": "YOUR_PREFERRED_MODEL_NAME",      // 设置您偏好的大语言模型名称,例如 "gpt-4", "mistral-medium" 等
        "UNICHAT_API_KEY": "YOUR_VENDOR_API_KEY"          // 填入您的大语言模型 API Key
      }
    }
  }
}

运行已发布的 npm 包版本 (更便捷的部署):

{
  "mcpServers": {
    "unichat-ts-mcp-server": {
      "command": "npx",
      "args": [
        "-y",
        "unichat-ts-mcp-server"
      ],
      "env": {
        "UNICHAT_MODEL": "YOUR_PREFERRED_MODEL_NAME",      // 设置您偏好的大语言模型名称,例如 "gpt-4", "mistral-medium" 等
        "UNICHAT_API_KEY": "YOUR_VENDOR_API_KEY"          // 填入您的大语言模型 API Key
      }
    }
  }
}

参数说明:

  • 'command': 启动服务器的命令,'node' 用于本地构建版本,'npx' 用于运行已发布的 npm 包。
  • 'args': 传递给命令的参数,本地构建版本需要指定 'build/index.js' 的路径。
  • 'env': 环境变量配置,包括:
    • 'UNICHAT_MODEL': 指定要使用的大语言模型名称。请参考 Unichat-ts 库支持的模型列表。
    • 'UNICHAT_API_KEY': 您需要提供对应大语言模型供应商的 API Key。

基本使用方法

  1. 启动 MCP 服务器: 根据您的配置方式启动 Unichat MCP 服务器。如果您使用本地构建版本,可以直接运行 'node build/index.js' 或 'npm run watch' (开发模式)。如果您使用 npm 包版本,MCP 客户端会自动启动。
  2. 配置 MCP 客户端: 将上述 JSON 配置添加到您的 MCP 客户端配置文件中(例如 Claude Desktop 的 'claude_desktop_config.json')。
  3. 在 MCP 客户端中使用: 在 MCP 客户端中,您应该能够看到 'unichat-ts-mcp-server' 服务器已连接。您可以开始使用 'unichat' 工具和预定义的 Prompt 模板,例如在 Claude Desktop 中,您可以:
    • 使用 '@unichat' 工具进行对话,例如 '@unichat messages: [{"role": "system", "content": "你是代码助手"}, {"role": "user", "content": "请帮我优化这段代码"}]'。
    • 使用 Prompt 模板进行代码处理任务,例如选择 "code_review" Prompt,并提供代码作为参数。

请参考 MCP 客户端的文档,了解如何在客户端界面中更详细地使用工具和 Prompt。

信息

分类

开发者工具