Vigil MCP 服务器

关键词

资源管理工具注册Prompt 渲染JSON-RPCLLM 集成

使用说明（Markdown 格式）

  • 项目简介 Vigil 内置一个基于 MCP 的服务端，用于向 LLM 客户端提供可访问的上下文信息、可注册的工具以及可渲染的 Prompt 模板。通过 /mcp 接口实现 MCP 的 JSON-RPC 通信，支持 Streaming Transport（流式传输）等传输方式，便于 Claude Desktop/Code/Cursor 等工具与后端协同工作。

  • 主要功能点

    • 资源管理（Resources）：托管和管理与上下文相关的数据资源，便于 LLM 查询和使用。
    • 工具注册与执行（Tools）：注册外部功能，LLM 可通过 MCP 调用外部工具执行任务。
    • Prompt 定义与渲染（Prompts）：定义可定制的 Prompt 模板，并按需求渲染给 LLM 客户端使用。
    • 会话与权限管理：内置会话、角色、认证与审计，确保对资源与工具的有序访问。
    • 多传输协议支持：包括 Streamable HTTP 等传输模式，提升与不同客户端的兼容性。
    • 与 Claude/Code/Cursor 等 MCP 客户端的集成能力：服务器端提供能力声明与调用入口，方便 LLM 客户端调用。

  • 安装步骤

    1. 克隆代码仓库并进入项目目录。
    2. 安装依赖：npm install
    3. 复制环境配置模板并按需修改，确保数据库/资源等配置就绪（如 .env）。
    4. 启动服务：npm start 或 node server.js，默认端口通常为 4100，具体以环境变量 VIGIL_PORT 为准。
    5. 验证 MCP 接入点：向 http://<host>:<port>/mcp 发送 MCP 请求（需使用 MCP 客户端进行连接，遵循客户端配置）。

  • MCP 服务器配置（客户端需要该信息以连接 MCP 服务）

    • 服务器名称（server name）：Vigil MCP Server
    • 启动命令（command）：node
    • 启动参数（args）：server.js
    • MCP 端点与传输
      • mcpEndpoint（MCP 服务地址）：http://localhost:4100/mcp
      • transport（传输方式）：streamable-http 说明：以上信息用于 MCP 客户端在连接 Vigil MCP 服务器时的必要参数，帮助客户端建立与 MCP 服务器的 JSON-RPC 通道。MCP 客户端本身不需要额外的实现细节，只需依据此配置与服务器建立连接。

  • 基本使用方法

    1. 启动 Vigil MCP 服务器（确保服务器处于运行状态并监听端口）。
    2. 使用 Claude Desktop/Code/Cursor 或其他 MCP 客户端，指向上述 mcpEndpoint，选择 transport 为 streamable-http。
    3. 客户端通过 MCP 进行资源读取、工具调用、提示模板获取等操作，服务器按 MCP 协议返回 JSON-RPC 响应。
    4. 如需扩展能力，可以在服务器端的路由/模块中增加新资源、工具和 Prompts，重新编译并重启服务。
    5. 如需查看运行状态与诊断信息，可以访问健康接口、审计日志等辅助端口。

  • 运行注意

    • 服务器需具备对外部工具的运行能力（若开启相应工具），如需要，请在部署环境中确保所需权限与依赖已经安装。
    • MCP 相关的客户端与服务对等协作依赖网络连通性，请在生产环境中确保防火墙/代理配置允许 /mcp 的访问。

服务器信息

访问项目