LocalBoards MCP Server

使用说明（Markdown 摘要）

• 项目简介

  • LocalBoards 使用 Nuxt 3 框架结合 MCP Toolkit 实现了一整套 MCP 服务器端，提供对看板系统数据的访问与操作能力，同时暴露大量 Tools 以供 LLM 调用外部功能，从而实现与人机协同的上下文服务。

• 主要功能点

  • MCP 服务器核心能力：处理 MCP 风格的工具、区域、卡片、看板等资源的创建、读取、更新、删除与排序等操作。
  • 注册并执行 Tools：包括创建、更新、删除卡片、区域、看板等工具，支持权限校验、通知生成等副作用。
  • 数据存储与逻辑：通过数据库（MySQL 等）进行数据持久化，包含看板、区域、卡片、评论、通知等表结构及其业务逻辑。
  • 身份认证与授权：集成 Better Auth 等，支持 API Key 和会话认证，权限控制看板、区域、卡片等操作。
  • 邮件通知：通过 sendEmail 组件实现对未读通知的邮件通知，增强协作体验。
  • 实际可运行：包含服务端 MCP 处理、工具实现、以及与客户端通信所需的服务端逻辑。

• 安装步骤

  • 克隆仓库
  • 安装依赖（如 npm install / pnpm install）
  • 配置环境变量（如 NUXT_APP_NAME、NUXT_BOARDS_URL、BETTER_AUTH_URL、数据库连接、邮件服务等）
  • 构建并运行：npx nuxt build；node ./server/index.mjs

• 服务器配置（供 MCP 客户端使用，JSON 配置示例说明） 注意：MCP 客户端不需要直接查看代码配置，以下信息用于 MCP 客户端启动连接的说明，与实际实现无关的注释仅做理解用途。 { "server_name": "LocalBoards", "command": "node", "args": ["./server/index.mjs"], "description": "LocalBoards MCP 服务端入口，提供资源与工具的 MCP 接口，供 LLM 客户端调用。", "notes": "该配置指向本地启动入口，生产环境下请根据实际部署路径调整。启动后客户端可以通过 MCP 客户端配置连接此服务器并调用工具、读写资源。" }

• 基本使用方法

  • 启动后，LLM 客户端通过 MCP JSON-RPC 机制向服务器请求资源、调用工具或获取 prompts。
  • 示例操作（由 MCP 客户端执行，非代码演示）：
    • 读取看板、区域、卡片等资源，获取当前结构和数据。
    • 调用工具创建/更新卡片、区域、看板等并处理返回结果。
    • 通过通知系统接收看板协作更新的邮件或前端通知。

• 说明

  • 本仓库的 MCP 服务端实现较为完整，覆盖资源管理与工具执行的核心场景，具备可运行性与实际应用意义。