Skip to content

Latest commit

 

History

History
25 lines (17 loc) · 1.81 KB

README.md

File metadata and controls

25 lines (17 loc) · 1.81 KB

Project Documentation

这个目录放项目级维护文档,重点描述当前代码的真实边界,而不是安装说明。安装和用户接入请优先看根目录 README.md / README.zh-CN.md;各 MCP 客户端的手动配置路径见 Client Configuration。

阅读顺序

  1. Technical Stack - 项目使用的 runtime、依赖、测试和发布工具链。
  2. Core Architecture - MCP server 的入口、分层和核心数据流。
  3. Capability Scope - 当前对外暴露的 MCP tools 和能力边界。

Workflows

常见变更的标准操作步骤,人和 agent 执行对应任务前先读:

维护约定

  • 改动 runtime、认证、host/base URL、CLI 入口或发布链路时,同步更新 Technical Stack。
  • 改动入口、transport(传输层)、tool 注册、client 封装或数据流时,同步更新 Core Architecture。
  • 新增、删除或修改 MCP tool、参数 schema、格式 enum 或资源类型时,同步更新 Capability Scope,并确认 tests/mcp/tool-registry-contract.test.ts 覆盖对应 contract(契约)。
  • 根目录两份 README 的工具表由 tests/docs/tool-surface-docs.test.ts 锁定,Capability Scope 由 tests/mcp/capability-scope-docs.test.ts 锁定,tool surface 变化时按测试失败提示同步更新文档。
  • 改动用户可见配置(环境变量、CLI 参数、支持的客户端列表)时,同步更新 README.md、README.zh-CN.md 和 Client Configuration;两份 README 保持逐节对应。