Skip to main content
Glama

docs

Read-onlyIdempotent

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

NameRequiredDescriptionDefault
topicYesOne 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.
detailNoDefault '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.
sectionNoOne section by the id listed in the summary index (or its exact heading text). Returns that section with its subsections.
project_idNoOptional project UUID, subdomain, slug, or 'default'. When supplied, the response also lists active runtime-fix notices for that project.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / topic / description
      Previous value: -"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, inbox, 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."New value: +"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."
  2. Changed1 schema field changed
    • changedInput schema / properties / topic / description
      Previous value: -"One of: adopt, analytics, api-surface, app-mcp, architecture-patterns, auth-client, billing, browser, calendar, changes, cli, common-mistakes, 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, inbox, 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."New value: +"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, inbox, 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."
  3. Changed1 schema field changed
    • changedInput schema / properties / topic / description
      Previous value: -"One of: analytics, api-surface, app-mcp, architecture-patterns, auth-client, billing, browser, calendar, changes, cli, common-mistakes, 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, inbox, 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."New value: +"One of: adopt, analytics, api-surface, app-mcp, architecture-patterns, auth-client, billing, browser, calendar, changes, cli, common-mistakes, 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, inbox, 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."
  4. First observed

TDQS

A4.5/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint and idempotentHint, yet the description still adds real behavior: a bounded default payload, a first line reporting `view` and `complete=true|false`, aliases resolving, unknown topics returning the canonical list, and `project_id` appending runtime-fix notices. The only omission is anything about size limits or truncation of `detail: "full"` output.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The structure is good and front-loaded — what it is, how it differs from siblings, how to page through it. However, the ~80-name topic enumeration duplicates the `topic` parameter's schema description verbatim at 100% coverage, consuming most of the description's length without adding information an agent doesn't already have.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With no output schema, the description carries the burden of explaining returns and does so: it describes the default bounded view, the `complete` flag, per-section retrieval, and full-topic retrieval. Combined with coverage of aliasing, unknown-topic failure mode, and the `project_id` side effect, an agent has everything needed to call this correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3, but the description adds genuine meaning beyond the schema: `section` ids come from the summary index (or exact heading text), topic aliases like fetch/http and ctx.* names resolve, and unknown topics return the canonical list. It also gives a concrete two-step call example (`{topic: sw.fetch}` then `{topic, section}`), which the schema does not.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The opening sentence gives a specific noun ('static manual') and the exact scope ('one platform surface at a time'), then enumerates the return payload (signatures, examples, patterns, failure modes). The line 'The tool list names verbs; docs defines their contracts' crisply separates this from the verb-invoking siblings, so an agent can pick it without opening the schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It explicitly names the alternatives and the condition that selects them: 'advisor({question}) provides tailored advice from supplied facts, and catalog lists available tools.' It also states the when-to-use for each view mode (bare call = bounded summary, `section` = one section, `detail: "full"` = whole topic), leaving nothing to inference.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources