docs
The static manual for one platform surface at a time. Returns signatures, examples, common patterns, failure modes, and exact behavior for deploy, sw.db, sw.auth, files, payments, and other primitives. The tool list names verbs; docs defines their contracts.
This is the static manual; advisor({ question }) provides tailored advice from supplied facts, and catalog lists available tools.
Returns a bounded summary by default: the read-first sections plus an id index of every section. The first line reports view and complete=true|false. section returns one section, and detail: "full" the complete topic.
Topics: adopt, analytics, api-surface, app-mcp, architecture-patterns, auth-client, billing, browser, calendar, changes, cli, common-mistakes, connect-agent, cors, cron, database-engine, declared-data, declared-files, deploy, deploy-intelligence, design-system, dev-environments, domain-ownership, domains, feedback, file-tools, functions, getting-started, github, guarantees, handled-for-you, inspect, limits, live, live-data, local-dev, migration-supabase, payments, portability, postgres, pricing, pricing-comparison, project-groups, projects, recipe-ai-agent, recipe-ai-features, recipe-ai-receipts, recipe-background-jobs, recipe-booking, recipe-csv-import, recipe-ecommerce, recipe-email, recipe-escalation, recipe-file-uploads, recipe-import-app, recipe-login, recipe-multi-chat, recipe-paid-api, recipe-pdfs, recipe-push-notifications, recipe-seo, recipe-signed-in-app, render, rooms, sdk, sdks, search, security-model, setup, smoke, speed, sql-compatibility, sw.agent, sw.ai, sw.auth, sw.billing, sw.db, sw.email, sw.endpoint, sw.env, sw.fetch, sw.fs, sw.groups, sw.image, sw.jobs, sw.logs, sw.notifications, sw.push, sw.rateLimit, sw.web, tasks, test, troubleshooting, typed-functions, verify-before-deploy, vs-supabase, vs-vercel. Aliases such as fetch/http/outbound and ctx.* names also resolve. Unknown topics return this canonical list. Example: { "topic": "sw.fetch" }, then { "topic": "sw.fetch", "section": "<id>" }.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"topic": "<topic>"
},
"name": "docs"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| topic | Yes | One of: adopt, analytics, api-surface, app-mcp, architecture-patterns, auth-client, billing, browser, calendar, changes, cli, common-mistakes, connect-agent, cors, cron, database-engine, declared-data, declared-files, deploy, deploy-intelligence, design-system, dev-environments, domain-ownership, domains, feedback, file-tools, functions, getting-started, github, guarantees, handled-for-you, inspect, limits, live, live-data, local-dev, migration-supabase, payments, portability, postgres, pricing, pricing-comparison, project-groups, projects, recipe-ai-agent, recipe-ai-features, recipe-ai-receipts, recipe-background-jobs, recipe-booking, recipe-csv-import, recipe-ecommerce, recipe-email, recipe-escalation, recipe-file-uploads, recipe-import-app, recipe-login, recipe-multi-chat, recipe-paid-api, recipe-pdfs, recipe-push-notifications, recipe-seo, recipe-signed-in-app, render, rooms, sdk, sdks, search, security-model, setup, smoke, speed, sql-compatibility, sw.agent, sw.ai, sw.auth, sw.billing, sw.db, sw.email, sw.endpoint, sw.env, sw.fetch, sw.fs, sw.groups, sw.image, sw.jobs, sw.logs, sw.notifications, sw.push, sw.rateLimit, sw.web, tasks, test, troubleshooting, typed-functions, verify-before-deploy, vs-supabase, vs-vercel. Canonical documentation topic identifier or alias (for example, sw.auth or auth-client). Unknown topics return the canonical topic list. | |
| detail | No | Default 'summary': a bounded view with the topic's read-first sections and an index of every section. 'full' returns the complete topic. The first response line reports view and complete=true|false. | |
| section | No | One section by the id listed in the summary index (or its exact heading text). Returns that section with its subsections. | |
| project_id | No | Optional project UUID, subdomain, slug, or 'default'. When supplied, the response also lists active runtime-fix notices for that project. |