将 Codex、Claude Code 和 Cursor 连接到 Fieldbook MCP

身份验证

每个请求都携带 Bearer 令牌。支持以下两种：

• API 密钥（现已可用）

  创建密钥，请前往你的 控制台 并以以下形式发送 Authorization: Bearer fb_live_…。密钥仅显示一次，系统只存储哈希值。

• Clerk OAuth（配置后可用）

  支持 OAuth 的客户端可通过以下地址发现授权服务器： /.well-known/oauth-protected-resource 并以交互方式完成身份验证，无需手动输入密钥。

连接

在启动编辑器或智能体的环境中设置 FIELDBOOK_TOKEN。示例引用此变量，请勿将真实 API 密钥提交到项目中。

codex mcp add fieldbook --url https://fieldbook.lizardi.mx/api/mcp --bearer-token-env-var FIELDBOOK_TOKEN

{
  "mcpServers": {
    "fieldbook": {
      "type": "http",
      "url": "https://fieldbook.lizardi.mx/api/mcp",
      "headers": {
        "Authorization": "Bearer ${FIELDBOOK_TOKEN}"
      }
    }
  }
}

{
  "mcpServers": {
    "fieldbook": {
      "url": "https://fieldbook.lizardi.mx/api/mcp",
      "headers": {
        "Authorization": "Bearer ${env:FIELDBOOK_TOKEN}"
      }
    }
  }
}

npx @modelcontextprotocol/inspector

工具

v2 规则包含 level、scopes、clusters、fineWhen 和 observes。suggest_alternatives 会将已停用的规则标识符解析为现有的后继规则。score_page 的 scope 可设为 page 或 section，intent 条目包含 ruleId 和 reason。cluster-v2 报告包含带有 status 和 points 的 flags，以及 reviews、hardFails、clusters、declared 和 changes。目录中的评分保留各自的 rulesetVersion。请求正文上限为 256 KiB，较大的页面请使用 url。超出上限的请求返回 HTTP 413 和 JSON-RPC 错误。

计量收费工具会消耗每月配额中的积分（所有者套餐不计量）。其余功能免费，并按密钥限流。

选中一张组件卡片。 每个组件都有四位数编号，显示在卡片和详情页上。浏览目录、选择组件，再将编号交给智能体。所有组件工具都接受 plate 替代 slug，以及类似的写法 0412, #412 或 FB-0412 也可识别。每个组件页面都提供标识符和即用提示词的复制按钮。

• search_components免费

  query?, category?, framework?, access?, maxSlopScore?, limit (max 25)

  在目录中搜索预览、访问级别和已测试框架。公开组件会显示安装命令；套餐包含的会员组件也会显示。

• get_component1 积分

  slug or plate, framework (default react)

  获取组件在所选框架下的源代码及演示，包含属性、依赖和安装指南。有效的 Pro 套餐包含会员组件；其他账户会收到 membership_required，且不消耗积分。

• list_frameworks免费

  slug or plate

  组件提供哪些框架版本，以及哪些移植版本尚未完成。

• get_install_command免费

  slug or plate, framework (default react)

  组件的安装命令、注册表 URL 和 components.json 配置片段。有效的 Pro 套餐包含会员组件。

• get_design_guidance免费

  query?, domain?, stack?, productType?, limit?

  搜索避免粗制设计的指南语料库。

• generate_design_system2 积分

  productType, keywords?, stack?, variance?, motion?, density?

  生成具有辨识度的设计系统：配色、字体、布局、动效、UX 规则及检查清单。

• get_slop_rules免费

  category?, level?, scope?

  为编程智能体获取 Fieldbook 的设计准则。

• get_font_guidance免费

  role?, family?, name?

  了解每种推荐字体的外观和表现，以及经过测试的搭配和背后的原则。

• suggest_alternatives免费

  ruleId

  获取设计问题的替代建议。

• score_page免费

  html? | url?, scope? (page | section), intent? [{ ruleId, reason }]

  按规则集为页面评分（通过 SSRF 防护获取 URL）。

注册表

直接安装公开组件，或使用下方的 components.json 注册表。有效的 Pro 套餐包含会员组件。

{
  "registries": {
    "@fieldbook": {
      "url": "https://fieldbook.lizardi.mx/r/react/{name}.json",
      "headers": {
        "Authorization": "Bearer ${FIELDBOOK_TOKEN}"
      }
    }
  }
}