Skip to content

docs: add Connect-MCP and Actions guides — the two missing landing-promise pages#3093

Merged
os-zhuang merged 1 commit into
mainfrom
docs/p1-mcp-actions-pages
Jul 17, 2026
Merged

docs: add Connect-MCP and Actions guides — the two missing landing-promise pages#3093
os-zhuang merged 1 commit into
mainfrom
docs/p1-mcp-actions-pages

Conversation

@os-zhuang

Copy link
Copy Markdown
Contributor

背景

文档审计定位出两个最严重的功能点缺口,本 PR 补齐(P1 第一批):

  1. MCP 接入无落点页——官网核心承诺"每个对象和动作自动成为受治理的 MCP 工具",但站内没有一页能让客户 10 分钟接通并验证,接入片段埋在 agents.mdx(页名不相关,没人会点)。
  2. action 无实战页——12 个功能点里覆盖最差:全站只有两处表格行 + forms 一个小节;"注册 handler"这步没有文档,已经导致过 AI 生成的按钮在生产环境点了没反应。

内容

ai/connect-mcp.mdx:一条命令接 Claude Code(localhost + 生产)/ Claude Desktop 与 claude.ai / .mcp.json / API key(铸造 + 三种 header 形式)/ 10 个生成工具清单 / 安全模型(调用者身份与 RLS、OAuth scopes 收窄工具族、action body 受信边界、TLS 规则)/ 验证一问 / 404-501-401-403 对症排错表。

ui/actions.mdx:诚实的类型表(script/flow/url/modal;api/form 标注"schema 有但 runtime 未接线",不教死属性)/ 定义 → 两条服务端路径(inline body 沙箱 vs onEnable 注册 handler,含"死按钮"陷阱 callout)/ locations 七值表 + 按名绑定(rowActions/quick_actions/导航)/ params/confirmText/resultDialog / requiredPermissions 双面闸门 / visible CEL fail-closed 陷阱 / REST 调用 / ai.exposed 暴露 / 排错表。

事实依据

两页均基于源码级调研(端点/认证/暴露规则/工具名/失败模式在 packages/runtime、packages/mcp、packages/spec 中逐条核实,调研清单带 文件:行号),示例原样摘自 examples/app-todo、app-showcase、app-crm 的真实可跑代码——不含任何杜撰 API。

导航:两个 meta.json 收录;agents.mdx 与 views.mdx 加了指向链接。与 #3092(P0 矛盾修正)无文件交集。

验证

pnpm --filter @objectstack/docs build ✅(MDX 全量编译含新页)

🤖 Generated with Claude Code

…omise pages

The docs audit found the two worst feature-point gaps:

- "Every object and action doubles as a governed MCP tool" is the site's
  core promise, but there was no page that gets a customer connected in
  10 minutes — the connect instructions were buried in agents.mdx.
- Actions had no hands-on page at all (two table rows and a forms aside),
  and shipped AI-generated dead buttons in production because the
  register-a-handler step was undocumented.

Both pages are grounded in source (endpoints, auth tracks, exposure rules,
tool names, failure modes verified in packages/runtime, packages/mcp,
packages/spec) and real bundled examples (app-todo, app-showcase, app-crm):

- ai/connect-mcp.mdx — one-command Claude Code connect (localhost + prod),
  Claude Desktop/claude.ai, .mcp.json, API keys (mint + 3 header forms),
  the 10 generated tools, security model (caller identity, OAuth scopes,
  trusted action bodies, TLS rule), verification question, and a
  symptom→fix troubleshooting table (404/501/401/403/missing-action).
- ui/actions.mdx — honest type table (script/flow/url/modal; api+form
  flagged as not wired), define → two server-behavior paths (inline body
  vs registered handler, incl. the "dead button" trap), locations +
  by-name bindings, params/confirm/resultDialog, dual-surface
  requiredPermissions, fail-closed visible CEL gotchas, REST invocation,
  ai.exposed opt-in, troubleshooting.

Nav: added to ai/ and ui/ meta.json; cross-links from agents.mdx and
views.mdx rowActions/bulkActions.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@vercel

vercel Bot commented Jul 17, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
spec Ready Ready Preview, Comment Jul 17, 2026 7:01am

Request Review

@github-actions github-actions Bot added documentation Improvements or additions to documentation size/m labels Jul 17, 2026
@os-zhuang
os-zhuang merged commit 37c12e8 into main Jul 17, 2026
14 of 15 checks passed
@os-zhuang
os-zhuang deleted the docs/p1-mcp-actions-pages branch July 17, 2026 07:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size/m

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant