使用说明

项目简介:

Unichat MCP Server 是一个 Python 实现的 MCP 服务器,它允许你通过 Model Context Protocol (MCP) 协议,使用工具和预定义的 Prompt 与多种大型语言模型 (LLM) 服务进行交互,如 OpenAI, MistralAI, Anthropic, xAI, Google AI 和 DeepSeek。它简化了 LLM 的集成,并提供了代码相关的 Prompt,例如代码审查、文档生成、代码解释和代码重构。

主要功能点:

  • 工具 (Tools): 提供 'unichat' 工具,允许客户端发送自定义消息与 LLM 进行对话。
  • Prompt 模板 (Prompts): 预定义了 'code_review', 'document_code', 'explain_code', 'code_rework' 等 Prompt,方便用户进行代码相关的操作。
  • 支持多种 LLM 服务: 可以配置使用 OpenAI, MistralAI, Anthropic, xAI, Google AI 和 DeepSeek 等多种 LLM 服务 (需要配置对应的 API Key)。
  • 基于 MCP 协议: 遵循 MCP 协议标准,可以与任何兼容 MCP 协议的客户端进行通信。

安装步骤:

  1. 安装 Python 环境: 确保你的系统安装了 Python 3.7 或更高版本。
  2. 安装依赖: 使用 'uv sync' 命令安装项目依赖 (根据 README)。
  3. 配置 API Key: 设置环境变量 'UNICHAT_API_KEY' 为你的 LLM 服务 API Key,并设置 'UNICHAT_MODEL' 为你想要使用的模型名称 (模型列表参考 https://github.com/amidabuddha/unichat/blob/main/unichat/models.py)。

服务器配置 (JSON):

为了让 MCP 客户端 (例如 Claude Desktop) 连接到 Unichat MCP Server,你需要配置客户端的 'mcpServers' 设置。以下是配置示例,你需要根据你的实际情况修改 'command' 和 'args' 中的路径:

"mcpServers": {
  "unichat-mcp-server": {
    "server name": "unichat-mcp-server",
    "command": "uv",
    "args": [
      "--directory",
      "{{your source code local directory}}/unichat-mcp-server", //  请将 '{{your source code local directory}}/unichat-mcp-server' 替换为你的 'unichat-mcp-server' 仓库的本地路径
      "run",
      "unichat-mcp-server"
    ],
    "env": {
      "UNICHAT_MODEL": "SELECTED_UNICHAT_MODEL", //  模型名称,例如 "gpt-4o-mini"
      "UNICHAT_API_KEY": "YOUR_OPENAI_API_KEY"      //  你的 LLM 服务 API Key
    }
  }
}

参数说明:

  • 'server name': 'unichat-mcp-server' (服务器名称,客户端用此名称来识别和连接服务器)
  • 'command': 'uv' (启动服务器的命令,这里假设你使用 'uv' 运行 Python 代码,你可能需要根据你的环境调整,例如使用 'python3' 或 'python')
  • 'args': 启动命令的参数列表:
    • '--directory': 指定服务器代码所在的目录。请将 '{{your source code local directory}}/unichat-mcp-server' 替换为你的实际代码仓库路径
    • 'run': 运行命令。
    • 'unichat-mcp-server': 要运行的 Python 模块或脚本名称。
  • 'env': 环境变量配置:
    • 'UNICHAT_MODEL': 指定要使用的 LLM 模型,例如 "gpt-4o-mini"。客户端配置时需要设置为 'SELECTED_UNICHAT_MODEL',实际运行时会被替换为环境变量中设置的模型名称。
    • 'UNICHAT_API_KEY': 你的 LLM 服务 API Key。客户端配置时需要设置为 'YOUR_OPENAI_API_KEY',实际运行时会被替换为环境变量中设置的 API Key。

基本使用方法:

  1. 启动 Unichat MCP Server。
  2. 在 MCP 客户端 (例如 Claude Desktop) 中配置并连接到 'unichat-mcp-server'。
  3. 在客户端中使用 'unichat' 工具或预定义的 Prompt (例如 'code_review', 'document_code' 等) 与 LLM 进行交互。

信息

分类

开发者工具