Winston AI MCP 服务器

使用说明内容(Markdown格式)

  • 项目简介

    • 该仓库实现了一个基于 MCP 的服务器端应用,核心功能是托管并管理若干“工具”(AI 文本检测、AI 图像检测、抄袭检测、文本对比),并通过 MCP 协议与客户端进行交互。
  • 主要功能点

    • MCP 服务器核心:建立并暴露 MCP 服务,支持通过标准工具注册、查询与执行。
    • 工具注册与执行:注册 ai-text-detection、ai-image-detection、plagiarism-detection、text-compare 四种工具,输入参数通过 zod 进行校验。
    • 外部调用集成:通过 Winston AI API 客户端(WinstonAiClient)调用实际的 AI 服务,返回格式化的文本结果。
    • 支持本地 STDIO 传输:采用 StdioServerTransport 作为 MCP 服务的传输方式,便于本地调试和集成测试。
    • 错误处理与回退:对 API 调用异常提供友好的错误信息返回。
  • 安装步骤

    1. 安装依赖并构建
      • 安装 Node.js 18 及以上版本
      • 在仓库根目录执行 npm install
      • 执行 npm run mcp-start 启动 MCP 服务器
    2. 运行方式(两种常见)
      • 直接在本地启动:env WINSTONAI_API_KEY=你的 API key npm run mcp-start
      • 通过 npx 启动(快速启动调试):WINSTONAI_API_KEY=你的 API key npx -y winston-ai-mcp
    3. Docker 运行(可选)
      • 将镜像构建后运行,并通过环境变量传入 WINSTONAI_API_KEY
  • 服务器配置(MCP 客户端需要的连接信息) 说明:MCP 客户端需要的配置通常包含服务器名称、启动命令和参数。以下为示例描述(文本形式),请按实际环境配置客户端连接信息。该配置示例仅用于说明,不需要直接在代码中执行。 { "server_name": "winston-ai-mcp", "command": "npx", "args": ["-y", "winston-ai-mcp"], "env": { "WINSTONAI_API_KEY": "your-api-key" } // 说明:server_name 对应 MCP 服务标识,command/args 指定服务器启动命令及参数,env 提供所需的环境变量。 }

  • 基本使用方法

    • 启动后,MCP 客户端可以通过工具名称调用工具,例如 ai-text-detection、ai-image-detection、plagiarism-detection、text-compare。
    • 客户端通过 JSON-RPC 2.0 的格式发送请求,服务器返回结构化文本或完整 API 响应的字符串形式。
    • 如遇网络或 API 错误,服务器将返回友好的错误信息,便于排错与重试。

服务器信息