Code Frontmatter MCP 服务器

关键词

frontmatterlanguage rulesYAML headersemantic metadataAI tooling

使用说明（Markdown 格式）

  • 项目简介 Code Frontmatter MCP Server 基于 Model Context Protocol (MCP) 构建，作为后端服务端，管理代码文件中的前置元数据头（CFM Frontmatter）、提供搜索、注册语言规则等能力，并通过 MCP 的工具接口向 AI 客户端暴露功能。

  • 主要功能点

    • cfm_read：扫描项目目录，提取并汇总所有代码文件的 CFM 表头信息，便于 AI 快速获取代码上下文。
    • cfm_write：将经过规范化的 CFM 表头写入指定文件，确保字段一致性与格式规范。
    • cfm_search：在代码库中按关键字、角色和领域等条件搜索匹配的 CFM 条目，并返回匹配结果及可能的解析错误。
    • cfm_register_language：在运行时注册新的语言注释规则，以支持更多语言的 CFM 表头解析。
    • 语言注册与解析：内置语言规则通过 registry.json 加载，支持按扩展名快速定位语言规则；可通过 register_language 动态扩展新语言。
    • 通过 stdio 传输的 MCP 服务：支持与 Cursor、Claude Desktop 等 MCP 客户端的互操作。

  • 安装步骤

    • 确保 Node.js 版本在 18+（或仓库要求的运行环境）。
    • 将代码克隆或下载到本地工作目录。
    • 安装依赖并准备运行环境（一般执行 npm install）。
    • 启动服务器示例（在 MCP 客户端中以 npx 方式启动，这也是官方 README 的推荐方式）： 使用 npx 直接运行：npx -y code-frontmatter 注：服务器以 MCP 标准 JSON-RPC 方式与客户端通信，默认通过标准输入输出（stdio）传输。

  • 服务器配置（供 MCP 客户端使用的配置描述） 服务器名称：code-frontmatter 启动命令：npx 启动参数：-y code-frontmatter

    具体配置（以 JSON 格式描述，供 MCP 客户端使用示意，非代码块展示）： { "server": "code-frontmatter", "command": "npx", "args": ["-y", "code-frontmatter"] }

    说明：该配置用于 MCP 客户端在本地启动并通过 MCP 服务器连通。客户端需要的仅是知道服务器名称、启动命令及参数即可与服务器建立连接。

  • 基本使用方法

    • 启动后，MCP 客户端可以通过调用以下工具来与代码库进行交互：
      • cfm_read: 获取项目根目录及子目录中所有代码文件的 CFM 表头索引与元数据。
      • cfm_write: 将新的或更新的 CFM 表头写入目标文件，确保导出、依赖、领域等字段的一致性。
      • cfm_search: 在项目中基于关键词、角色、领域等条件搜索匹配的 CFM 条目，并返回结果与错误信息（若存在损坏的表头）。
      • cfm_register_language: 在运行时注册对新语言的 CFM 表头解析支持。
    • 使用时请按 MCP 客户端的要求，将以上工具作为具有输入参数的 JSON-RPC 请求来调用。

  • 重要事项

    • 服务器实现遵循 MCP 的 JSON-RPC 形式，与客户端交互的工具均有清晰的输入输出定义。
    • 代码设计包含前言注释头、Zod 校验、YAML 解析、语言注册、Shebang/行前缀处理等，覆盖常见的情景与异常情况。
    • 如需扩展语言支持，推荐使用 cfm_register_language 动态注册新语言规则。

服务器信息

访问项目