DesignerPunk MCP Documentation Server

使用说明

• 项目简介
  • 该仓库实现了一个 MCP 服务器端，用于向 AI 客户端按统一标准提供文档资源、可调用的工具和可渲染的提示模板，核心通过 JSON-RPC 与客户端通信，便于跨平台、可扩展的上下文服务。
• 主要功能点
  • 资源托管与访问：对文档、令牌系统、跨文档引用等进行机械化提取与索引，提供简化的数据访问能力。
  • 工具注册与执行：实现 8 种 MCP 工具（如获取文档地图、文档摘要、全文、特定段落、跨引用、元数据校验、索引健康、重建索引等），客户端可通过统一接口调用。
  • Prompt 模板与模板渲染：提供可渲染的提示模板结构，便于 AI 客户端形成高质量的交互上下文。
  • 会话与能力声明：服务器维护会话状态、支持能力声明，确保 AI 客户端知道可用的查询能力。
  • 多传输与扩展：支持多种传输协议（如 Stdio、SSE、WebSocket）的集成，方便在不同应用场景中接入。
  • 安全与容错：错误封装、日志记录、重建索引和文件监控等，确保稳定性与可维护性。
• 安装步骤
  • Clone 本仓库并进入项目根目录。
  • 安装依赖并构建服务器代码：
    • 安装依赖并编译服务器端代码（通常使用 TypeScript 项目编译流程）。
  • 运行服务器：
    • 使用构建产物启动 MCP 服务器（入口一般为 dist/mcp-server/index.js）。
• 服务器配置（供 MCP 客户端在连接时参考，客户端无需执行此步骤）
  • 服务器名称：mcp-documentation-server
  • 启动命令与参数（示例 JSON 配置，用于 MCP 客户端接入，描述性注释用以帮助理解，不作为代码直接执行）： { "server_name": "mcp-documentation-server", "command": "node", "args": ["dist/mcp-server/index.js"], "env": { "MCP_STEERING_DIR": ".kiro/steering/" }, "notes": "启动时若希望指定 steering 目录，请通过 MCP_STEERING_DIR 环境变量覆盖默认路径（默认 .kiro/steering/）。" }
• 基本使用方法
  • MCP 客户端通过发送 JSON-RPC 风格的请求到服务器，调用诸如获取文档地图、文档摘要、指定段落、跨引用等工具；服务器返回标准化的 JSON-RPC 风格响应。
  • 开始时，客户端可以先请求工具列表以了解可用能力，然后按需逐步调用 map → summary → section 的渐进式查询以实现更高的上下文效率。
  • 如需监控与调试，可观察服务器日志与性能指标，结合重建索引、文件监听等功能确保数据的时效性与一致性。