CodeFire MCP 服务器

使用说明(简明易懂的使用指南)

  • 项目简介

    • CodeFire 的 MCP 服务器实现是一个本地后端进程,主要职责是以标准化的 MCP 协议向 AI 客户端(如 Claude Code、Gemini CLI、Codex CLI、OpenCode 等)提供上下文数据、可注册的工具集合和提示模板。它使用本地 SQLite 数据库作为持久化存储,全部通信通过标准的 JSON-RPC over stdio 完成。
    • MCP 服务器在代码中以独立的 Node 进程形式实现,并通过 @modelcontextprotocol/sdk 的 MCP 服务组件暴露工具集,用于对外提供“读取资源、执行工具、获取提示模板”等能力。
  • 主要功能点

    • 资源与数据:通过内置数据库暴露和管理项目信息、任务、笔记、会话、代码片段等资源,便于 LLM 获取上下文。
    • 工具注册与执行:服务器注册大量工具(如获取当前项目、列出项目、查询任务、读取笔记、执行浏览器命令等),LLM 可以通过 MCP 调用这些工具执行外部功能。
    • 提示模板与渲染:支持与上下文相关的 Prompt、模板和提示渲染能力,便于与 LLM 的对话进行更丰富的上下文管理。
    • 本地化与安全:全部在本地运行,使用本地 SQLite 数据库,通信通过 stdio(无网络监听),保证数据在本地可控。
    • 兼容性与集成:与 CodeFire 的多端平台(macOS、Windows、Linux)的其他组件(Swift/Electron 客户端)共用数据模型和 MCP 结构,方便与多种 AI 客户端配合使用。
  • 安装与运行步骤

    • 依赖与构建
      • 该 MCP 服务器是 CodeFire 应用的一部分,通常通过打包整合在 Electron 构建产物中运行。具体构建步骤由 CodeFire 的打包流程控制(包括 Swift/macOS、Electron 的打包等)。
    • 启动方式
      • MCP 服务器作为独立进程运行,常与客户端(如 Claude Code、Gemini CLI、Codex CLI、OpenCode)配合使用。客户端通过配置指向该服务器的启动命令与参数来建立连接。
    • 运行环境要求
      • 需要本地 Node 环境与 SQLite 数据库权限,MCP 服务器通过 stdio 与客户端进行通信,确保本地资源可以被安全访问。
    • 注意事项
      • 服务器要求数据库存在并且已经通过 Migration 初始化。CodeFire 的打包流程会自动处理数据库初始化和 Migration。
      • 运行时要确保 CodeFire 的 MCP 服务已正确注册并监听 stdio 流。
  • 服务器配置(MCP 客户端使用的连接信息) 说明:MCP 客户端需要提供一个配置来连接 MCP 服务器。以下 JSON 字符串描述了一个合理的配置字段,客户端不需要代码,只需按文本格式填写或导入配置即可: { "name": "codefire", "command": "/path/to/CodeFireMCP", // MCP 服务器可执行文件的路径,需要替换为实际操作系统中的真实路径 "args": [] // 传递给 MCP 服务器的启动参数(如无可为空数组) } 注释:上述配置中的 command 指向已打包/可执行的 MCP 服务器程序,CodeFire 的 MCP 服务器在仓库中通过 mcp/server.ts 实现,实际运行通常由打包后的可执行文件提供。客户端配置仅用于建立与 MCP 服务器的连接,后续通信由 MCP 协议处理。

  • 基本使用方法

    • 启动并连接
      • 启动 CodeFire 的 MCP 服务器进程;在客户端(如 Claude Code 等)中提供该服务器的启动命令与参数,以建立 JSON-RPC 通信。
    • 调用工具
      • 通过 MCP 客户端向服务器发起请求(如读取资源、执行工具等),服务器返回 JSON-RPC 响应或通知。
    • 会话与上下文
      • MCP 服务器在后端维护会话、能力声明,并对资源、工具、Prompts 等进行管理,为 LLM 提供一致的上下文服务。
    • 安全与扩展
      • 服务器设计支持多种传输和扩展方式,确保在本地环境中的安全、可扩展性和与不同前端/客户端的兼容性。
  • 额外说明

    • 代码位置与实现要点:核心 MCP 实现位于 electron/src/mcp/server.ts,使用 MCP Server(McpServer)以及 stdio 传输(StdioServerTransport)实现,结合本地 SQLite 数据库进行数据持久化与快速查询。
    • 该实现具备注册工具、管理资源、渲染 Prompts 的能力,并以标准化的 MCP 协议对外提供服务,符合 MCP 服务器的核心要求。
  • 参考信息

    • 仓库中 MCP 服务器实现和相关示例位于 CodeFire 的 Electron 子系统中,MCP 服务通过独立进程暴露、供各类 AI 客户端连接使用。

服务器信息