DB Planner

DB Planner MCP 服务

面向 DB Planner 的托管 MCP 服务，允许任何 MCP 客户端编辑数据库架构（DBML/SQL）、Mermaid 图表和白板布局。通过 OAuth 登录，无需安装。

https://api.dbplanner.io/mcp

本仓库仅包含文档。该服务已集成到 DB Planner API 中，无需运行任何代码：将 URL 添加到客户端，在浏览器中登录一次，Agent 即可使用项目中的 38 个工具。

什么是 DB Planner

DB Planner 是一款协作式数据库设计工具。你可以用 DBML 编写架构或导入 SQL 转储文件（PostgreSQL、MySQL 和 SQL Server），用 Mermaid 绘制图表，并将两者布局到共享白板上，实时呈现关系、注释和绘图。模板市场用于分享已发布的架构。

连接

Claude Code

claude mcp add --transport http db-planner https://api.dbplanner.io/mcp

Cursor 和其他使用 JSON 配置的客户端

{
  "mcpServers": {
    "db-planner": {
      "type": "http",
      "url": "https://api.dbplanner.io/mcp"
    }
  }
}

url 在所有客户端中都相同；但 type 值各不相同。Claude Code 的 .mcp.json 如上所示，使用 http；Cursor 的 .cursor/mcp.json 不需要 type；而 Cline 的 mcp.json 使用 streamableHttp。请查阅客户端文档，了解其远程服务配置格式。

Claude.ai 和 Claude Desktop

依次选择 Settings、Connectors、Add custom connector。粘贴 URL。将身份验证保留为 "Always required"，并将 OAuth 客户端设置为 "register one automatically"。无需添加标头。

MCP Inspector

npx @modelcontextprotocol/inspector

点击 Add Servers，然后填写表单：服务器 ID 为 db-planner，传输方式为 streamable-http，URL 为 https://api.dbplanner.io/mcp。添加并启用后，浏览器中会打开授权页面。

在任何客户端中，首次调用工具时都会打开 DB Planner 授权页面。登录并选择权限范围，即可完成连接。客户端配置不会存储密码或 API 密钥。代表你进行设置的 Agent 应阅读 llms-install.md。

身份验证

此端点通过带 PKCE 的 OAuth 2.1 进行保护。发现机制采用标准实现，因此客户端仅凭 URL 即可完成配置：

• https://api.dbplanner.io/.well-known/openid-configuration
• https://api.dbplanner.io/.well-known/oauth-protected-resource
• 在 https://api.dbplanner.io/connect/register 进行动态客户端注册，适用于公共客户端（token_endpoint_auth_method=none）和机密客户端（client_secret_post、client_secret_basic）

全部权限模型由两个范围构成，且权限划分由服务端而非客户端强制执行：

范围	授予的权限
dbplanner:read	所有读取工具。始终授予，因为此端点要求该权限。
dbplanner:write	可修改数据的工具，逐个工具检查权限。也涵盖向公共市场发布内容。

MCP 客户端会请求这两个范围。读取权限始终授予；写入权限在授权页面上以复选框形式提供，默认勾选。取消勾选后，即使客户端请求了写入权限，颁发的令牌也不会包含该权限，因此只读连接是真正有保障的，而非仅依赖客户端的配合。

客户端还会请求 offline_access。这是一种会话机制，而非权限：它会提供刷新令牌，使连接在令牌过期后仍能继续使用；只要请求了该权限，就会予以授予。

工具所能访问的内容不会超出已登录用户在应用中的可见范围：组织和项目角色根据令牌中的主体信息解析，并由 Web 应用所用的同一套服务强制执行。

工具

每个工具都包含标题、只读或破坏性操作提示、值为 false 的 openWorldHint、每个参数的描述以及输出架构，因此客户端可以在无需确认提示的情况下执行读取操作，并获取结构化结果，而不是解析文本。

分组	读取	写入
会话	whoami、get_public_profiles
组织	list_orgs、get_org	create_org、rename_org、delete_org、upsert_org_member、remove_org_member
项目	list_projects	create_project、update_project、delete_project、upsert_project_member、remove_project_member
文档	list_documents、list_diagrams	create_document、update_document、delete_document、reorder_documents、set_table_color
看板	get_board、get_board_image、list_tables、list_drawings	update_board、draw、draw_shape、erase_drawings、add_board_image
Marketplace	browse_templates、get_template、list_my_listings	use_template、publish_listing、update_listing、unpublish_listing

Agent 调用这些工具前，有几点值得了解：

• 设计内容位于文档中，绝不在看板上。 表、列、引用、枚举、类和流程图步骤都是通过解析文档生成的，因此设计通过 create_document 和 update_document 进行更改，看板则随之更新。没有可直接创建表的工具。
• get_board_image 会将看板渲染为 PNG，让模型查看布局，而不是根据坐标推断。传入 format='svg' 可将矢量源作为文本获取。
• draw 和 draw_shape 是绘图工具。 墨迹和箭头由同一个工具处理，并通过 kind 指定；矩形、菱形和椭圆则由另一个工具处理，且可选择绑定文本。两者都会生成 ID，并像应用一样对坐标进行取整。独立文本、分组和链接则通过 update_board 处理。
• update_board 接收部分增量。 只发送要更改的卡片 ID；值为 null 时会删除对应卡片。它使用与应用相同的合并约定，因此 Agent 移动一张卡片时，不会覆盖协作者的布局。
• 只有创建者可以发布，且工具不接受价格。 只有创建项目的人可以将其上架，通过 MCP 发布的内容始终免费。设置价格需要完成 Stripe 入驻，而其他人无法代替用户操作。

上架平台

• Official MCP Registry，条目为 io.dbplanner/db-planner
• Smithery
• Glama
• mcp.so
• cursor.directory

支持

如有疑问或问题，请联系：[email protected]。产品文档位于 dbplanner.io/features。

许可证

本文档依据 MIT License 发布。DB Planner 本身是一款托管产品；请参阅 dbplanner.io/pricing。