使用说明(Markdown 格式)

项目简介

  • 该项目在 Klondike Spec CLI 的代码库中实现了一个 MCP 服务器,用以把 Klondike 的资源(features.json、agent-progress.json、config.yaml 等)、工具(如 get_features、start_feature、verify_feature、start_session 等)以及状态信息以 MCP 客户端可调用的方式暴露出去。服务器通过 FastMCP 实现 MCP 协议的工具接口、会话管理和状态查询等能力,并可通过不同传输协议进行通信(如 stdio、streamable-http 等)。

主要功能点

  • 按 MCP 工具暴露 Klondike 的核心能力
    • 工具集合:get_features、get_feature、start_feature、verify_feature、block_feature、get_status、start_session、end_session、validate_artifacts 等
    • 资源访问:从 .klondike 目录读取/写入 features.json、agent-progress.json、config.yaml 等
    • 会话与状态管理:创建与结束会话,更新进度与快速参考
    • 数据同步:在变更后自动更新 agent-progress.md、进度文件等人类可读内容
  • 与 MCP SDK 的集成
    • 使用 FastMCP 提供服务器端实现,通过装饰器 @mcp.tool() 将方法暴露为 MCP 工具端点
    • 支持不同传输协议(stdio、streamable-http 等),便于在不同环境中集成
  • 配置与安装
    • 提供用于生成 MCP 配置的 API 和命令(generate_mcp_config、generate_vscode_mcp_config),方便集成到客户端(如 VS Code)的配置
    • 客户端的使用无需你仓库中的实现细节,只需要正确的配置即可连接
  • 与 Klondike CLI 的集成
    • klondike mcp serve 启动 MCP 服务器
    • klondike mcp config 输出服务器配置 JSON,供 MCP 客户端使用
    • 当 MCP SDK 不可用时,程序会退回友好状态,测试用例提供了回退路径
  • 运行环境与依赖
    • 需要 Python 3.10+,以及可选依赖(mcp 库)用于实际 MCP 通信
    • 代码中通过 MCP_AVAILABLE 开关控制是否开启 MCP 相关功能,未安装时保持安全降级

信息

分类

AI与计算