使用说明

项目简介

Unichat MCP Server 是一个 Model Context Protocol (MCP) 服务器的实现，旨在为大型语言模型 (LLM) 客户端提供代码处理和分析能力。它通过工具和预定义的 Prompt 模板，简化了与不同 LLM API 的集成，并提供了代码审查、文档生成、代码解释和代码重构等功能。

主要功能点

工具 (Tools):
- 'unichat': 与配置的 LLM 模型进行对话，可以用于执行各种代码相关的任务。
Prompt 模板 (Prompts):
- 'code_review': 代码审查，检查代码的最佳实践、潜在问题和改进点。
- 'document_code': 代码文档生成，为代码生成包括文档字符串和注释在内的文档。
- 'explain_code': 代码解释，详细解释一段代码的工作原理。
- 'code_rework': 代码重构，根据用户提供的修改意见，重构给定的代码。
多 LLM API 支持: 支持 OpenAI, MistralAI, Anthropic, xAI, Google AI, DeepSeek 等多种 LLM API (需要配置相应的 API 密钥)。
传输协议: 支持 STDIO 和 SSE 两种传输协议。

安装步骤

安装 Node.js 和 npm: 确保你的系统已安装 Node.js 和 npm。

克隆仓库: 使用 Git 克隆仓库到本地：

git clone https://github.com/amidabuddha/unichat-ts-mcp-server.git
cd unichat-ts-mcp-server

安装依赖: 在仓库目录下运行以下命令安装项目依赖：
```
npm install
```
构建项目: 运行以下命令构建 TypeScript 代码：
```
npm run build
```

服务器配置

为了让 MCP 客户端 (例如 Claude Desktop) 连接到 Unichat MCP Server，你需要在客户端的配置文件中添加 MCP 服务器的配置信息。以下是配置示例，你需要根据你的实际情况修改路径和 API 密钥。

本地运行配置 (构建后):

{
  "mcpServers": {
    "unichat-ts-mcp-server": {
      "command": "node",  // 启动服务器的命令，这里使用 Node.js
      "args": [
        "{{/path/to}}/unichat-ts-mcp-server/build/index.js" // 服务器入口文件路径，请替换为实际路径
      ],
      "env": {
        "UNICHAT_MODEL": "YOUR_PREFERRED_MODEL_NAME",  // 你想要使用的 LLM 模型名称，例如 "gpt-4o-mini"
        "UNICHAT_API_KEY": "YOUR_VENDOR_API_KEY"  // 你的 LLM API 密钥
      }
    }
  }
}

发布包运行配置 (全局安装后): 首先，你可以选择全局安装该服务器包：

npm install -g unichat-ts-mcp-server

然后，配置 MCP 客户端：

{
  "mcpServers": {
    "unichat-ts-mcp-server": {
      "command": "npx",  // 启动服务器的命令，使用 npx 运行已安装的包
      "args": [
        "-y",
        "unichat-ts-mcp-server" // 要运行的 npm 包名称
      ],
      "env": {
        "UNICHAT_MODEL": "YOUR_PREFERRED_MODEL_NAME",  // 你想要使用的 LLM 模型名称，例如 "gpt-4o-mini"
        "UNICHAT_API_KEY": "YOUR_VENDOR_API_KEY"  // 你的 LLM API 密钥
      }
    }
  }
}

请注意替换 'YOUR_PREFERRED_MODEL_NAME' 和 'YOUR_VENDOR_API_KEY' 为你实际的模型名称和 API 密钥。支持的模型列表可以在仓库的 'src/models.ts' 文件中找到。

基本使用方法

启动服务器: 根据你的配置方式，启动 Unichat MCP Server。如果使用本地运行配置，在仓库根目录下运行 'node build/index.js' (或 'npm start' 如果你在 package.json 中配置了 start 脚本)。如果使用发布包运行配置，MCP 客户端会自动启动服务器。
配置 MCP 客户端: 将上述服务器配置信息添加到你的 MCP 客户端 (例如 Claude Desktop) 的配置文件中。
使用工具和 Prompt: 在 MCP 客户端中，你可以调用 'unichat' 工具进行对话，或者使用 'code_review', 'document_code' 等 Prompt 模板来执行代码相关的任务。具体使用方法请参考你的 MCP 客户端的文档。

关键词