Toolkit-MD MCP 服务端

使用说明

  • 项目简介 Toolkit-MD 的 MCP 服务端实现用于在本地或远程环境中以 MCP 协议为载体,与 LLM 客户端进行标准化的上下文服务交互。服务器端提供了对 Markdown 内容的资源化管理、工具注册与执行,以及各种 Prompt 的渲染与使用,支持多种传输协议(如 STDIO、SSE、WebSocket)。

  • 主要功能点

    • MCP 服务端:实现核心的 MCP 交互,注册并暴露多种工具,支持 JSON-RPC 请求与响应。
    • 资源管理:通过内容提供者(FileSystemProvider、MockProvider 等)管理 Markdown 内容的加载、写入、更新与删除。
    • 工具注册与执行:暴露内容最佳实践、内容摘要、内容审阅、翻译等工具,供 MCP 客户端调用。
    • Prompt 渲染与模板:提供多种 Prompt 构建器(上下文提示、风格指南、示例、翻译等),实现灵活的对话模板与上下文组合。
    • 安全与可扩展性:包含会话管理、语言配置、配置管理、样式指南与示例内容等,确保在 IDE/IDEA 插件等环境中可扩展使用。
  • 安装步骤

    • 全局安装并直接运行 MCP 服务端(配合 MCP 客户端使用)
    • 推荐方式:全局安装 Toolkit-MD,然后执行 toolkit-md mcp 即可启动 MCP 服务器。
  • 服务器配置(MCP 客户端所需信息,下方为示例描述,非代码块) 服务器配置用于 MCP 客户端连接到服务器。配置项包括服务器名称、启动命令与参数等,示例配置如下(描述性说明,不直接展示代码):

    • server name: toolkit-md
    • command: toolkit-md
    • args: ["mcp"]
    • 说明:该配置指示 MCP 客户端通过指定命令和参数启动服务器进程,并以标准输入输出(STDIO)方式进行通信。端口、认证等通常在 MCP 框架内由底层传输实现与安全机制处理。
  • 基本使用方法

    1. 启动 MCP 服务器 在包含本仓库的项目环境中,执行 CLI 命令 toolkit-md mcp 启动 MCP 服务端。
    2. 连接客户端 使用 MCP 客户端(Cursor、Cline、Q Developer 等)通过 JSON-RPC 与服务器建立连接,完成资源读取、工具调用与提示渲染等交互。
    3. 调用示例 通过 MCP 客户端请求工具如 content_summary_information、content_review_guidance、content_translation_guidance 等,服务器将返回相应的 JSON-RPC 响应或渲染后的 Prompts。
    4. 运行与扩展 如需添加新的工具或自定义 Prompt,可在服务器端扩展相应工具注册逻辑与 Prompt 构建器,重新启动服务端即可生效。
  • 额外说明

    • 服务器端通过 Stdio 传输实现,亦可在需要时扩展为 SSE/WebSocket 等传输协议。
    • 配置与语言、样式指南、示例内容等均在代码中以灵活的配置对象实现,便于在不同项目中快速适配。

服务器信息