vobase MCP 服务器

使用说明:

  • 项目简介
    • vobase 内置的 MCP 服务器:在同一个 Bun 进程中运行,通过 /mcp 路由对外提供 MCP 相关的能力,允许 LLM 客户端读取模型资源、注册与执行工具,以及获取和渲染 Prompt 模板。
    • 服务器核心能力包括:资源/数据读取、工具注册与执行、Prompt 渲染信息等,以统一的 JSON-RPC (MCP) 协议响应客户端请求,支持多种传输方式。
  • 主要功能点
    • 资源与数据访问:读取、查询和渲染与资源相关的信息。
    • 工具注册与执行:提供可由 LLM 调用的外部功能接口,返回结构化结果。
    • 提示模板管理:支持对 Prompt/模板的获取与渲染,便于定制化交互。
    • 会话与权限:通过同一应用上下文管理会话、错误处理与日志,确保安全性与审计能力。
    • 与客户端通信:基于 JSON-RPC 的请求/响应格式,服务端在同进程中共享端口。
    • 传输与通知:就绪后可通过 HTTP 流式传输等方式向客户端发送通知或响应。
  • 安装步骤
    • 安装依赖并构建运行环境(仓库已有完整类型化实现,依赖 Bun/Node 等运行时)。
    • 启动应用后,确保后端进程在指定端口监听,MCP 服务在同一端口提供 /mcp 路由。
  • 服务器配置
    • MCP 客户端配置示例(以 JSON 表示,描述服务器信息、启动命令和参数;实际使用中客户端会读取此信息以建立连接)。该配置对应仓库实现的集成方式: { "serverName": "vobase-mcp-server", "command": "bun", "args": ["run", "server.ts"], "notes": "MCP 服务与主后端在同一 Bun 进程中运行,端口同后端暴露的端口(默认 3000)。MCP 通过 /mcp 路由提供服务。" } 注释说明:
    • serverName 表示 MCP 服务的名称,便于在多服务环境中区分。
    • command 与 args 指定启动 MCP 服务的命令及参数。在本仓库场景下,通常为启动主后端的命令形式,MCP 功能在同进程中启用。
    • 端口与路由信息在实际部署时由主应用暴露,客户端应将目标地址指向主后端端口的 /mcp 路由。
  • 基本使用方法
    • 启动后端应用,确保 mcp 功能已开启(在模板中为 mcp: { enabled: true } 的配置)。
    • 使用 MCP 客户端通过 POST 请求向 /mcp 发送 MCP JSON-RPC 请求,如查询工具、读取模块、获取架构等,服务端返回符合 MCP 规范的 JSON-RPC 响应。
    • 如需自定义工具或数据源,请在后端模块中实现并注册,MCP 客户端即可通过工具名称调用。

服务器信息