ctx-sys MCP 服务器

使用说明内容(Markdown 格式)

  • 项目简介

    • ctx-sys 是一个基于 MCP 的本地后端服务,用于为大语言模型客户端提供统一的上下文资源、可执行工具和可渲染的提示模板,并将代码、文档、会话记忆等上下文以结构化方式暴露给 LLM,以提升对话质量和开发效率。
  • 主要功能点

    • 资源管理:托管和查询代码、文档等可用资源,提供数据访问能力。
    • 工具注册与执行:注册可被 LLM 调用的外部功能工具,支持参数化调用。
    • 提示模板与渲染:定义和渲染可定制的提示模板,支持多样的对话场景。
    • MCP 通信:使用 JSON-RPC 规范与客户端通信,支持请求/通知等模式。
    • 会话与能力声明:管理对话会话、展示服务器能力,并支持多传输协议。
    • 本地化运行:本地索引、向量检索、图灵关系等机制,全部在本地完成,不需要云端传输。
  • 安装步骤

    • 先安装 Node.js 环境(推荐 18+)。
    • 安装并构建项目依赖(如 npm install)。
    • 运行服务命令(假设部署在本地环境,后续可根据实际配置调整)。
    • 配置 MCP 客户端以连接该服务器。
  • 服务器配置

    • MCP 客户端连接需要的最小配置信息以 JSON 形式给出,示例字段包括服务器名称、启动命令和参数。实际使用中请参考下方描述进行配置: { "serverName": "ctx-sys", "command": "ctx-sys", "args": ["serve"] }

    • 说明:

      • serverName: MCP 客户端将使用的服务器标识名,建议与服务器端实际名称保持一致,便于管理与切换。
      • command: 启动服务器的可执行命令;这里是 ctx-sys。
      • args: 启动命令的参数,常用的启动参数为 ["serve"],用于启动 MCP 服务端。
      • 如需扩展传输协议或额外安全设置,可在后续配置中扩展字段。
    • 注意:以上配置仅用于 MCP 客户端在本地环境中发现并连接服务器。实际部署时请按你的环境将路径与参数替换为可执行的真实命令及参数。

  • 基本使用方法

    • 启动服务器后,客户端通过 MCP JSON-RPC 进行资源读取、工具调用和提示获取等请求。
    • 客户端可以请求当前系统提供的资源、注册的工具、以及可渲染的提示模板等信息,用于构建对话上下文。
    • 通过标准的传输通道(如 STDIO、SSE、WebSocket 等)进行交互,确保数据传输的可靠性和安全性。
    • 服务器负责会话管理、能力宣告,以及对接入客户端的安全与扩展性要求,便于将复杂的本地代码库和知识图谱提供给 LLM 使用。
  • 备注

    • 该实现目标是一个完整的 MCP 服务器端应用,而非仅仅的示例客户端。请在你的部署环境中确保 MongoDB/SQLite 等存储或本地缓存等组件的可用性与性能配置。

服务器信息