Huly MCP服务器
使用说明
- 项目简介
- 该仓库实现一个 MCP 服务器端，提供资源管理、工具注册与执行、以及 Prompt 模板的渲染能力。服务器通过 JSON-RPC 与 LLM 客户端进行通信，具备会话管理、能力声明，以及对多种传输协议的支持，旨在为 LLM 应用提供结构化、可扩展的上下文服务。
- 主要功能点
- 资源托管与访问：管理可供 LLM 客户端读写的资源与文档数据。
- 工具注册与执行：定义并暴露工具接口，LLM 可以通过工具调用外部功能。
- Prompt 模板定义与渲染：提供模板化的提示以适配不同交互场景。
- JSON-RPC 通信：统一的请求/响应格式，支持错误映射和结果封装。
- 多传输协商：默认标准输入输出（stdio），可切换为 HTTP（Streamable HTTP）等传输，支持会话感知和并发请求处理。
- 会话管理与能力声明：在运行时维护服务器状态、暴露服务器能力与工具集信息。
- 安装步骤
- 该服务器对外提供可发布的 npm 包 @firfi/huly-mcp，通常在实际部署时使用 npm/yarn 直接安装运行。
- 典型流程包括：安装 Node.js 环境 -> 安装 MCP 服务器 -> 启动服务器（指定传输方式） -> 配置客户端连接信息。
- 服务器配置
- MCP 服务器客户端需要连接信息，示例配置（JSON 表达）如下，请按需替换具体值： { "serverName": "huly", "command": "npx", "args": ["-y", "@firfi/huly-mcp@latest"], "env": { "HULY_URL": "https://huly.app", "HULY_EMAIL": "[email protected]", "HULY_PASSWORD": "yourpassword", "HULY_WORKSPACE": "yourworkspace" } } 说明与要点：
- serverName：服务器实例名称，便于在多服务器场景中区分。
- command/args：启动 MCP 服务器所需的命令及参数，通常用于无容器化环境的快速启动。
- env：用于 MCP 服务器连接到 Huly 实例所需的认证和工作区信息。至少包含 HULY_URL 与 HULY_WORKSPACE，认证信息可使用邮箱/密码或 API Token（详见 README 的鉴权说明）。
- 注意：MCP 客户端并不需要该配置的代码示例，只需知道服务器启动方式及连接参数即可。
- 基本使用方法
- 启动与连接
- 在支持的环境中，以服务器方式启动 MCP 服务端（可使用 stdio 或 http 传输）。
- 客户端配置好服务器地址与传输方式后，便可通过 MCP 的 JSON-RPC 进行资源读取、工具调用和提示渲染等操作。
- 常用操作流程
- 读取/浏览资源：LLM 客户端请求访问某个资源的内容。
- 调用工具：LLM 客户端通过工具注册表调用外部功能（如获取项目信息、创建对象等）。
- 获取/渲染 Prompts：LLM 客户端请求渲染特定 Prompt 模板以获得上下文化的交互文本。
- 运行环境与运维
- 支持 stdio 与 http 传输，部署时可根据产线网络策略选择合适的传输协议。
- 服务器具备容错能力与日志机制，必要时可通过配置启动参数调整超时、并发等参数。
- 启动与连接