Skip to content

docs(ai),liveness: open-edition honesty for the agent capability - #2812

Merged
os-zhuang merged 1 commit into
mainfrom
docs/agent-open-edition-honesty
Jul 11, 2026
Merged

docs(ai),liveness: open-edition honesty for the agent capability#2812
os-zhuang merged 1 commit into
mainfrom
docs/agent-open-edition-honesty

Conversation

@os-zhuang

Copy link
Copy Markdown
Contributor

Three "declared ≠ delivered on the open edition" cleanups surfaced by a whole-platform agent-capability audit. No behavior change — docs + liveness _note annotations only.

1. aggregate_data over-claim (Natural Language Queries)

The doc told readers their own AI gets query_records / get_record / aggregate_data via the open @objectstack/mcp. But the open native HTTP surface (mcp-http-tools.ts) registers exactly 9 toolslist_objects, describe_object, query_records, get_record, create_record, update_record, delete_record, list_actions, run_action — and none is aggregate_data; query_records has no aggregation arguments. aggregate_data is a cloud data tool (cloud/.../tools/data-tools.ts); in framework the name appears only in a read-only classification set (mcp-server-runtime.ts:54), never as a registered tool. Fixed: the doc lists the real open read tools and fences aggregation to the cloud runtime with a callout.

2. "Skill" terminology collision

Two unrelated concepts share the word "skill," both under /docs/ai:

  • Authoring skills (skills.mdx / skills-reference.mdx) = SKILL.md knowledge modules (skills.sh) that teach a coding assistant to write metadata — open, dev-time, never run.
  • Agent skills (defineSkill / SkillSchema in agents.mdx) = runtime capability bundles attached to the ask/build platform agents — cloud runtime.

agents.mdx even used both senses within a few lines. Added cross-linked disambiguation callouts to both pages.

3. Liveness cites cloud code as framework evidence

The agent/skill/tool/action liveness ledgers point evidence at packages/services/service-ai/src/... — but that framework tree is a stale, untracked build artifact (git ls-files returns nothing; no src/, no package.json). The real consumer is the closed cloud @objectstack/service-ai. So the open framework's own ledger reads as if it locally enforces an agent runtime it doesn't contain — the single most confusing artifact for anyone auditing "what does open actually do." Each file's _note now states the evidence lives in cloud/EE and these props are live because that cloud runtime consumes them.

Verification

  • Liveness gate green (check:liveness exit 0, "all governed-type properties classified"; staleEvidence is a warning that never counted toward failure, so no regression).
  • Callout type="warn" is an already-used variant; anchor target confirmed; Callout tags balanced in all edited files; all four liveness JSONs re-validated.

The audit's larger finding — that the platform's agent capability is bifurcated (open = MCP + authoring schemas + knowledge; cloud/EE = the entire execution runtime, ask/build, conversation store, chat backend) — is left as-is: the open/cloud line in content/docs/ai/index.mdx already draws it correctly. This PR only removes the three concrete honesty gaps.

🤖 Generated with Claude Code

Three fixes from the whole-platform agent-capability audit — all "declared ≠
delivered on the open edition" cleanups, no behavior change:
1. aggregate_data over-claim — Natural Language Queries said your own AI gets
`query_records` / `get_record` / `aggregate_data` via the open
`@objectstack/mcp`. The open native HTTP surface registers 9 tools and
NONE is `aggregate_data`; `query_records` has no aggregation args.
`aggregate_data` is a cloud data tool. Doc now lists the real open read
tools and fences aggregation to the cloud runtime.
2. "Skill" terminology collision — `docs/ai/skills.mdx` (authoring SKILL.md
modules for coding assistants, open, skills.sh) and `defineSkill` /
SkillSchema in `agents.mdx` (runtime capability bundles on ask/build, cloud)
are unrelated concepts sharing one word, both under /docs/ai. Added
cross-linked disambiguation callouts to both pages.
3. liveness cites cloud code as framework evidence — agent/skill/tool/action
liveness files point `evidence` at `packages/services/service-ai/...`, which
is a stale untracked build artifact; the real consumer is the closed cloud
`@objectstack/service-ai`. Each `_note` now states this, so the open/cloud
line is clear to anyone auditing what the open edition actually enforces.
Liveness gate green (staleEvidence stays a warning, not a failure); Callout
variants/anchors/tag-balance verified.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@vercel

vercelBot commented Jul 11, 2026

Copy link
Copy Markdown

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

ProjectDeploymentActionsUpdated (UTC)
specReadyReadyPreview, CommentJul 11, 2026 1:56am

Request Review

@github-actionsgithub-actionsBot added documentation Improvements or additions to documentation tooling size/s labels Jul 11, 2026
@github-actions

Copy link
Copy Markdown
Contributor

📓 Docs Drift Check

This PR changes 1 package(s): @objectstack/spec.

94 hand-written doc(s) reference the affected code and may need an implementation-accuracy re-verification:

  • content/docs/ai/agents.mdx(via @objectstack/spec)
  • content/docs/ai/skills-reference.mdx(via @objectstack/spec)
  • content/docs/ai/skills.mdx(via @objectstack/spec)
  • content/docs/api/client-sdk.mdx(via @objectstack/spec)
  • content/docs/api/environment-routing.mdx(via @objectstack/spec)
  • content/docs/api/error-catalog.mdx(via @objectstack/spec)
  • content/docs/api/error-handling-client.mdx(via @objectstack/spec)
  • content/docs/api/error-handling-server.mdx(via @objectstack/spec)
  • content/docs/api/index.mdx(via @objectstack/spec)
  • content/docs/automation/approvals.mdx(via packages/spec)
  • content/docs/automation/flows.mdx(via @objectstack/spec)
  • content/docs/automation/hook-bodies.mdx(via packages/spec)
  • content/docs/automation/hooks.mdx(via @objectstack/spec)
  • content/docs/automation/index.mdx(via @objectstack/spec)
  • content/docs/automation/webhooks.mdx(via @objectstack/spec)
  • content/docs/automation/workflows.mdx(via @objectstack/spec)
  • content/docs/concepts/architecture.mdx(via @objectstack/spec)
  • content/docs/concepts/design-principles.mdx(via packages/spec)
  • content/docs/concepts/index.mdx(via @objectstack/spec)
  • content/docs/concepts/metadata-driven.mdx(via @objectstack/spec)
  • content/docs/concepts/metadata-lifecycle.mdx(via packages/spec)
  • content/docs/concepts/north-star.mdx(via packages/spec)
  • content/docs/data-modeling/analytics.mdx(via @objectstack/spec)
  • content/docs/data-modeling/drivers.mdx(via @objectstack/spec)
  • content/docs/data-modeling/external-datasources.mdx(via @objectstack/spec)
  • content/docs/data-modeling/field-types.mdx(via @objectstack/spec)
  • content/docs/data-modeling/fields.mdx(via @objectstack/spec)
  • content/docs/data-modeling/formulas.mdx(via @objectstack/spec)
  • content/docs/data-modeling/index.mdx(via @objectstack/spec)
  • content/docs/data-modeling/objects.mdx(via @objectstack/spec)
  • content/docs/data-modeling/queries.mdx(via @objectstack/spec)
  • content/docs/data-modeling/schema-design.mdx(via @objectstack/spec)
  • content/docs/data-modeling/seed-data.mdx(via @objectstack/spec)
  • content/docs/data-modeling/validation-rules.mdx(via @objectstack/spec)
  • content/docs/data-modeling/validation.mdx(via @objectstack/spec)
  • content/docs/deployment/troubleshooting.mdx(via @objectstack/spec)
  • content/docs/getting-started/build-with-claude-code.mdx(via @objectstack/spec)
  • content/docs/getting-started/cli.mdx(via @objectstack/spec)
  • content/docs/getting-started/common-patterns.mdx(via @objectstack/spec)
  • content/docs/getting-started/examples.mdx(via @objectstack/spec)
  • content/docs/getting-started/quick-reference.mdx(via @objectstack/spec)
  • content/docs/getting-started/quick-start.mdx(via @objectstack/spec)
  • content/docs/getting-started/validating-metadata.mdx(via @objectstack/spec)
  • content/docs/kernel/cluster.mdx(via @objectstack/spec)
  • content/docs/kernel/contracts/auth-service.mdx(via packages/spec)
  • content/docs/kernel/contracts/cache-service.mdx(via packages/spec)
  • content/docs/kernel/contracts/data-engine.mdx(via @objectstack/spec)
  • content/docs/kernel/contracts/index.mdx(via @objectstack/spec)
  • content/docs/kernel/contracts/metadata-service.mdx(via packages/spec)
  • content/docs/kernel/contracts/storage-service.mdx(via packages/spec)
  • content/docs/kernel/index.mdx(via packages/spec)
  • content/docs/kernel/runtime-services/email-service.mdx(via packages/spec)
  • content/docs/kernel/runtime-services/index.mdx(via packages/spec)
  • content/docs/kernel/runtime-services/queue-service.mdx(via packages/spec)
  • content/docs/kernel/runtime-services/sharing-service.mdx(via packages/spec)
  • content/docs/kernel/runtime-services/sms-service.mdx(via packages/spec)
  • content/docs/kernel/runtime-services/storage-service.mdx(via packages/spec)
  • content/docs/kernel/services-checklist.mdx(via @objectstack/spec)
  • content/docs/permissions/authorization.mdx(via @objectstack/spec)
  • content/docs/permissions/permission-sets.mdx(via @objectstack/spec)
  • content/docs/permissions/permissions-matrix.mdx(via @objectstack/spec)
  • content/docs/permissions/positions.mdx(via @objectstack/spec)
  • content/docs/permissions/sharing-rules.mdx(via @objectstack/spec)
  • content/docs/plugins/adding-a-metadata-type.mdx(via @objectstack/spec)
  • content/docs/plugins/development.mdx(via @objectstack/spec)
  • content/docs/plugins/index.mdx(via @objectstack/spec)
  • content/docs/plugins/packages.mdx(via @objectstack/spec)
  • content/docs/protocol/backward-compatibility.mdx(via @objectstack/spec)
  • content/docs/protocol/diagram.mdx(via packages/spec)
  • content/docs/protocol/knowledge.mdx(via @objectstack/spec)
  • content/docs/protocol/objectos/config-resolution.mdx(via @objectstack/spec)
  • content/docs/protocol/objectos/i18n-standard.mdx(via @objectstack/spec)
  • content/docs/protocol/objectos/lifecycle.mdx(via @objectstack/spec)
  • content/docs/protocol/objectos/plugin-spec.mdx(via @objectstack/spec)
  • content/docs/protocol/objectos/runtime-capabilities.mdx(via @objectstack/spec)
  • content/docs/protocol/objectql/index.mdx(via packages/spec)
  • content/docs/protocol/objectql/query-syntax.mdx(via @objectstack/spec)
  • content/docs/protocol/objectql/schema.mdx(via @objectstack/spec)
  • content/docs/protocol/objectql/security.mdx(via packages/spec)
  • content/docs/protocol/objectql/state-machine.mdx(via @objectstack/spec)
  • content/docs/protocol/objectui/actions.mdx(via @objectstack/spec)
  • content/docs/protocol/objectui/concept.mdx(via @objectstack/spec)
  • content/docs/protocol/objectui/index.mdx(via @objectstack/spec)
  • content/docs/protocol/objectui/layout-dsl.mdx(via packages/spec)
  • content/docs/protocol/objectui/record-alert.mdx(via @objectstack/spec)
  • content/docs/protocol/objectui/widget-contract.mdx(via @objectstack/spec)
  • content/docs/releases/implementation-status.mdx(via @objectstack/spec)
  • content/docs/releases/index.mdx(via @objectstack/spec)
  • content/docs/releases/v9.mdx(via @objectstack/spec)
  • content/docs/ui/create-vs-edit-form.mdx(via @objectstack/spec)
  • content/docs/ui/dashboards.mdx(via @objectstack/spec)
  • content/docs/ui/forms.mdx(via @objectstack/spec)
  • content/docs/ui/index.mdx(via @objectstack/spec)
  • content/docs/ui/setup-app.mdx(via @objectstack/spec)

Advisory only. To re-verify, run the docs-accuracy-audit workflow scoped to these files:
node scripts/docs-audit/affected-docs.mjs origin/main → pass the list as args.docs.

@os-zhuang
os-zhuang merged commit 82c0d94 into mainJul 11, 2026
17 checks passed
@os-zhuang
os-zhuang deleted the docs/agent-open-edition-honesty branch July 11, 2026 01:56
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentationImprovements or additions to documentationsize/stooling

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

@os-zhuang