Skip to content

docs(ai): document the core LLM-tools preset#3774

Draft
caio-pizzol wants to merge 1 commit into
mainfrom
caio-pizzol/docs-ai-core-preset
Draft

docs(ai): document the core LLM-tools preset#3774
caio-pizzol wants to merge 1 commit into
mainfrom
caio-pizzol/docs-ai-core-preset

Conversation

@caio-pizzol

Copy link
Copy Markdown
Contributor

Documents the core LLM-tools preset: a compact three-tool surface (agent_inspect, agent_recipe, execute_code) where SuperDoc keeps control of targeting, argument validation, edits, verification, and receipts. It sits next to the existing LLM Tools page, which covers the broader grouped intent catalog, and gives embedded agents a smaller surface that is easier to audit and verify.

The new page is linked from the AI overview, the LLM Tools page, the docs nav, and llms.txt. Tool names and the 29-recipe list are taken from the SDK source so the page matches what the model actually sees, rather than a hand-maintained list that drifts.

Verified: recipe names cross-checked against the SDK recipe registry (29, exact match); docs.json parses; internal doc links resolve to existing pages.

Add a guide for the three-tool core preset (agent_inspect, agent_recipe,
execute_code), where SuperDoc keeps control of targeting, validation,
edits, verification, and receipts. Wire it into the AI overview, the LLM
Tools page, the docs nav, and llms.txt.

Tool names and the recipe list are taken from the SDK source so the page
matches what the model actually sees.
@caio-pizzol caio-pizzol requested a review from a team as a code owner June 25, 2026 17:11
@github-actions

Copy link
Copy Markdown
Contributor

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 6a20c7d9a5

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

} from '@superdoc-dev/sdk';

// Provider-shaped tool definitions for the core preset.
const { tools } = await chooseTools({ provider: 'openai', preset: 'core' });

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Badge Register the core preset before documenting it

When readers copy this example, chooseTools({ preset: 'core' }) resolves through the SDK preset registry, but the Node registry currently only contains legacy (packages/sdk/langs/node/src/presets.ts:162) and the Python registry mirrors that. That means the documented call throws PRESET_NOT_FOUND instead of returning the three advertised tools; dispatchSuperDocTool also still dispatches only the default preset. Please either land/register the core preset and preset-aware dispatch first, or avoid publishing these docs as a working API.

Useful? React with 👍 / 👎.

@caio-pizzol caio-pizzol marked this pull request as draft June 26, 2026 16:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant