OASTools MCP 服务器

使用说明(简要)

  • 项目简介
    • 该仓库在 oastools 中实现了一个 MCP 服务器模块,通过命令行子命令 mcp 启动,向 LLM 客户端暴露资源、工具、Prompts 等 MCP 能力,采用 JSON-RPC 进行请求/响应通信,且具备会话管理和跨传输协议的能力门控。
  • 主要功能点
    • 资源管理与数据访问:托管并管理用于上下文的资源/数据。
    • 工具注册与执行:注册外部工具,允许 LLM 客户端调用外部功能。
    • Prompt 模板定义与渲染:提供可自定义的 Prompt 模板,用于 LLM 的上下文交互。
    • JSON-RPC 通信:与客户端通过标准的 JSON-RPC 进行请求/通知/响应。
    • 会话与能力声明:服务器端维护会话、能力描述,支持多传输协议。
    • 多传输协议支持:通过不同传输通道与客户端交互(如 STDIO、SSE、WebSocket)。
  • 安装与运行
    • 你需要在有 Go 环境的机器上构建并运行,该 MCP 服务器作为 oastools 的一个子命令存在。构建并安装后,可以通过 oastools mcp 启动 MCP 服务。
    • 注意:MCP 客户端的配置需要一个启动服务器的命令与参数,以便通过客户端启动服务并建立连接。客户端配置见下方的服务器配置示例。
  • 服务器配置(供 MCP 客户端使用)
    • 说明:MCP 客户端需要一个描述服务器启动方式的配置(JSON)。该配置包含服务器名称、启动命令和参数,以便客户端在需要时启动 MCP 服务器并建立连接。
    • 示例配置(请按实际环境替换):
      • serverName: "oastools-mcp-server"
      • command: "oastools"
      • args: ["mcp"]
    • 配置字段释义
      • serverName:对 MCP 服务器的唯一标识名称,便于管理和日志识别。
      • command:启动 MCP 服务器所需的主命令,可以是本仓库提供的可执行项名(如 oastools)。
      • args:启动命令的参数列表;此处通常为 ["mcp"],表示以 oastools mcp 子命令启动 MCP 服务器。
  • 基本使用方法
    • 启动 MCP 服务器:在具备运行环境的机器上执行包含 MCP 服务实现的可执行入口,或通过集成的 oastools mcp 子命令启动。
    • 连接客户端:MCP 客户端读取配置(serverName、command、args),在需要时启动 MCP 服务器进程并通过 JSON-RPC 进行上下文服务请求(读取资源、执行工具、获取 Prompt 等)。
    • 会话与安全:服务器端负责会话管理和能力声明,客户端可通过能力协商获得相应的上下文服务能力。
    • 传输通道:支持 STDIO、SSE、WebSocket 等传输,在不同环境中以合适方式传输 JSON-RPC。

服务器信息