Kindred Paths MCP 服务端

使用说明

  • 项目简介
    • 该仓库实现了一个基于 MCP(Model Context Protocol)的服务器端,名为 Kindred Paths MCP 服务端。它暴露一组工具(Tools)和资源接口,允许 LLM 客户端读取卡牌资源、注册并执行外部工具、以及获取/渲染提示模板等功能。服务器通过 JSON-RPC 与客户端通信,具备会话管理、能力声明以及对资源、工具与模板的统一访问入口。
  • 主要功能点
    • 资源与卡牌管理:提供对卡牌、集合、设计文档、艺术资源等的访问、创建、更新、删除等能力。
    • 工具(Tools)注册与执行:支持多种工具,例如获取卡牌、渲染卡牌、卡牌创建/更新/删除、艺术生成、设计文档操作等,均通过 MCP 的工具注册机制暴露。
    • 提示模板与渲染:提供设计文档、设计蓝图以及渲染/预览等功能,方便与 LLM 的交互集成。
    • 会话与存储协作:与本地文件系统、Git 存储等后端资源协作,提供同步、提交、备份等能力。
    • 传输与部署:核心实现通过标准输入输出(stdio)传输与 MCP 客户端进行通信,便于在开发环境下与 Claude 等工具集成;也具备清晰的后端接口与路由设计,便于扩展。
  • 安装步骤
    • 进入 MCP 服务器部分目录,安装依赖并编译(如使用 TypeScript,通常需要安装依赖并运行构建命令)。确保 Node.js 运行环境就绪。
    • 启动服务器:通过标准输入输出传输模式运行服务器,这样 MCP 客户端即可通过标准流(stdio)与之通信。
    • 常见环境变量与配置(若需 AI 相关功能,需提供相应 API key;本实现中还涵盖艺术生成与卡牌渲染等功能所需的资源与路径配置)。若与你的环境对接 Claude、Leonardo AI、本地艺术目录等,需确保对应依赖和路径正确配置。
  • 服务器配置(客户端无需关注,仅供 MCP 客户端参考) 下面给出配置示例(JSON 格式,供 MCP 客户端在 Claude Desktop 等环境中注册服务器时使用)。说明见每项字段后的注释。 { "serverName": "kindred-paths", "command": "node", "args": ["mcp/build/index.js"] } 说明:
    • serverName:服务器在 MCP 客户端配置中的名称,建议与仓库中的服务名保持一致,便于管理与识别。
    • command:启动服务器的命令,这里使用 node。
    • args:启动命令的参数,指向编译输出后用于执行的入口文件路径(如 mcp/build/index.js)。如果你直接运行 TS 源代码,需要根据你的运行环境(如 ts-node)调整命令。
  • 基本使用方法
    • 第一步:确保 MCP 服务端已正确启动(在支持 MCP 的环境中,使用配置中的 serverName、command 与 args 将服务器注册到客户端)。
    • 第二步:在 LLM 客户端(如 Claude Desktop、或其他集成工具)中,将 Kindred Paths 的 MCP 服务器添加到 mcpServers 配置,指定启动命令与参数,以建立与 MCP 客户端的连接。
    • 第三步:通过 MCP 提供的工具(如 get_cards、render_cards、create_cards、delete_cards、design_documents、art_generation 等)来与卡牌资源、设计文档、艺术生成等进行交互,返回的内容通常以 JSONRPC 的 content 或文本/图片等形式返回。
    • 第四步:根据需要调整后端存储(本地文件系统、Git 仓库等)配置,以确保数据持久化与同步。
  • 运行与调试要点
    • 确认依赖与环境变量就绪(AI 服务通常需要 API KEY)。
    • 确认本地存储路径(如卡牌、艺术等目录)存在且有写入权限。
    • 若要与 Claude Desktop 的集成测试,请确保 Claude Desktop 已正确指向本 MCP 服务器,并在配置中使用 serverName、command、args 进行绑定。
  • 备注
    • 该实现面向开发与集成场景,包含大量工具注册与资源管理逻辑,适合在本地开发环境进一步扩展或在 CI 环境中进行集成测试。

服务器信息