Veritas Kanban MCP 服务器

关键词

Model Context ProtocolJSON-RPCResourcesToolsPrompts

使用说明内容（Markdown格式）

项目简介

Veritas Kanban 内置的 MCP 服务器用于向 AI 助手（如 Claude Desktop 等）提供结构化的上下文和外部功能能力。核心能力包括对资源（Resources）的数据访问、对工具（Tools）的注册与执行、以及对提示模板（Prompts）的定义与渲染。服务器通过 JSON-RPC 与 MCP 客户端通信，支持会话管理、能力声明，并可通过多种传输协议（如 StdIO、SSE、WebSocket）实现实时交互，面向本地-first 的开发场景，便于与本地代理或 AI 框架集成。

主要功能点

  • MCP 核心能力
    • 资源托管：为 AI 客户端提供可访问的数据资源接口。
    • 工具注册与调用：注册外部功能，LLM 可以通过 MCP 调用实现外部任务。
    • Prompt 模板：定义、渲染并提供可定制的提示模板，适配不同的对话/任务场景。
    • 会话管理与能力声明：支持声明服务器能力、会话生命周期。
  • 协议与传输
    • 采用 JSON-RPC 风格的请求/响应交互，便于与各大 LLM 平台对接。
    • 支持多种传输通道（如 StdIO、SSE、WebSocket），以适配不同使用场景。
  • 安全与可扩展性
    • 通过 server-side 的会话和能力管理实现访问控制和日志审计。
    • 设计为可扩展的后端模块，便于接入新的资源、工具及 Prompts。

安装步骤

  • 安装依赖并编译
    • 在仓库根目录执行依赖安装（如 pnpm install）。
    • 构建 MCP 服务器模块（若仓库提供构建脚本，则执行相应构建命令）。
  • 启动 MCP 服务器
    • 根据部署环境选择开发或生产配置启动 MCP 服务。
    • MCP 服务启动后会监听并暴露 MCP 接口，供 MCP 客户端连接使用。

服务器配置（MCP 客户端连接所需）

MCP 客户端在与服务器建立连接前，需要提供一份 JSON 配置，描述 MCP 服务器的启动命令及参数。仓库中提供的示例配置如下，请将其中的路径替换为实际部署路径，并确保环境变量按需配置： { "mcpServers": { "veritas-kanban": { "command": "node", "args": ["/path/to/veritas-kanban/mcp/dist/index.js"], "env": { "VK_API_URL": "http://localhost:3001" } } } } 说明：

  • server name：veritas-kanban，表示 MCP 服务器在客户端配置中的标识名称。
  • command：启动 MCP 服务所需的命令，这里以 node 为例。
  • args：启动命令的具体参数，指向 MCP 服务器的打包/编译输出入口（dist/index.js）。
  • env：必要的环境变量，示例中将 VK_API_URL 指向 Veritas Kanban 的 API 服务地址，供 MCP 服务与后端通信。

注意：此配置是 MCP 客户端需要的连接参数示例，实际部署时请把路径与端口等信息改为你的环境配置，且客户端本身并不需要读取服务器端的实现细节代码。

基本使用方法

  • 部署阶段
    • 启动 Veritas Kanban 的后端 API 与前端 UI（如数据库、任务板等），确保 MCP 服务可访问 VK_API_URL 指定的后端接口。
    • 启动 MCP 服务器进程，使其对外提供 Resources、Tools、Prompts 的服务能力。
  • 客户端接入
    • 使用 MCP 客户端将以上配置加载，建立与 MCP 服务器的连接，开始通过 JSON-RPC 请求读取资源、注册工具、渲染 prompts，并在需要时调用外部工具。
  • 运行与监控
    • 通过系统日志和 MCP 客户端日志观察请求/响应流程，确保资源/工具/Prompts 的注册、查询与调用工作正常。

服务器信息

访问项目