Convex MCP Visual

关键词

Convex实时仪表盘ER 图代码地图命令行工具

使用说明书（简要概览，便于快速上手）:

  • 项目简介

    • 该仓库实现了一个基于 Model Context Protocol (MCP) 的服务器端，核心职责是通过标准化接口向 LLM 客户端提供资源、工具、以及提示相关的内容，以支持对 Convex 数据库的上下文感知与外部功能调用能力。

  • 主要功能点

    • MCP 服务端核心能力
      • 注册并暴露可执行工具（Tools），如模式浏览、仪表盘、ER 图、代码地图、热图、模式漂移、写冲突等。
      • 管理并提供资源（Resources），用于读取和呈现 UI、数据等内容。
      • 提供跨客户端交互的接口，支持 JSON-RPC 风格的请求/响应。
    • 支持多传输方式
      • stdio（默认 MCP 模式）
      • HTTP（通过端口暴露 http 服务）
    • 服务器端 UI 与数据展示
      • 为 LLM 交互提供可视化交互面板（浏览模式、仪表盘、图表等），以及多种开发者工具的可视化实现。
    • 部署键/配置管理
      • 集成 Convex 部署键与连接部署的能力，便于在不同环境中快速对接 Convex 后端。

  • 安装与运行步骤

    1. 准备环境
      • 需要 Node.js 版本（推荐 v18+）。
    2. 安装/使用 MCP 服务器
      • 通过 npm/npx 安装并运行：
        • npx convex-mcp-visual --stdio（以 stdio 传输模式启动 MCP 服务器，常用于 Claude/Cursor/OpenCode/Codex 等客户端）
        • 或 npx convex-mcp-visual --http --port 3001（以 HTTP 传输模式启动，端口自定义）
    3. 部署键配置
      • 运行 npx convex-mcp-visual --setup 进行交互式设置（读取 .env.local/项目部署等信息），或手动设置环境变量：
        • export CONVEX_DEPLOY_KEY="prod:deployment-name|your-admin-key"
        • 及可选：export CONVEX_URL="https://deployment-name.convex.cloud"
    4. 与 MCP 客户端集成
      • 配置 MCP 客户端以连接到服务器（客户端不需要在此处暴露，配置文件会指明服务器名称、启动命令和参数等）。
      • CLI 子命令可直接探索 Schema / Dashboard / Diagram 等工具的输出，或通过 MCP 客户端与服务器进行交互。
    5. 测试连接
      • 使用 npx convex-mcp-visual --test 进行连接性测试，若部署和密钥正确应输出可用表、部署地址等信息。

  • 服务器配置（示例） 配置信息用于 MCP 客户端注册服务器与启动参数，JSON 格式，字段含 server、command、args，注释说明如下：

    • server: 服务器在 MCP 客户端中的名称标识
    • command: 启动该 MCP 服务器的命令
    • args: 启动命令的参数数组 注释信息示例（非代码区直接展示）： 服务器名称：convex-visual 启动命令：npx 参数：["convex-mcp-visual", "--stdio"] 描述：Convex MCP Visual 的 MCP 服务器，用于 Claude Desktop / Cursor / OpenCode / Codex 等客户端的上下文服务

    下面给出配置条目（为直观用途，请将其作为“配置对象”直接使用），具体字段含义如上所述： { "server": "convex-visual", "command": "npx", "args": ["convex-mcp-visual", "--stdio"], "description": "Convex MCP Visual 的 MCP 服务器，提供资源、工具、与上下文模板等能力" }

  • 基本使用方法

    • 启动方式
      • stdio 模式：npx convex-mcp-visual --stdio
      • http 模式：npx convex-mcp-visual --http --port 3001（端口可自定义）
    • 部署键/配置
      • 设置部署键：npx convex-mcp-visual --setup，或导出 CONVEX_DEPLOY_KEY 与 CONVEX_URL
    • 直接 CLI 测试与工具使用
      • 运行 npx convex-mcp-visual schema 查看 Schema 浏览器工具输出
      • 运行 npx convex-mcp-visual dashboard 查看仪表盘工具输出
      • 运行 npx convex-mcp-visual diagram 查看 Mermaid ER 图输出
    • MCP 服务端与客户端协作
      • MCP 服务端负责暴露工具、资源、以及需要的上下文数据接口，客户端通过配置连接后即可调用工具、请求资源、或获取 Prompts/模板等。

服务器信息

访问项目