get_token_catalog

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

Describes behavior: fetch from remote sync source or local cache, credentials from env vars, returns parsed token tree, themes, metadata. Without annotations, the description carries the full burden and adequately discloses that it is a read operation (fetch) but does not explicitly state non-destructive nature or potential failures.

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

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

Single paragraph with clear structure: core purpose, then specific behaviors (override, credentials, filtering). Front-loaded with main action. No redundant sentences, but could be slightly more concise.

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

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

Given no output schema, the description covers return type (parsed token tree, themes, metadata). For a complex tool with nested parameters and multiple sources, it is fairly complete. Could mention error cases or what happens if sync is misconfigured, but still strong.

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

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

Schema description coverage is 50% (only setFilter and pathPrefix have descriptions). The description adds significant meaning: explains `override` as pointing to different repo/branch/file path, mentions auto-discovery, and clarifies credential sourcing. Compensates well for missing schema descriptions.

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

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

Clearly states it fetches the canonical Tokens Studio token catalog from various remote sync sources or local cache. Distinguishes from siblings by mentioning related tool `get_token_storage_config` and implies difference from `list_tokens` which likely lists without fetching full catalog.

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

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

Provides explicit guidance to call `get_token_storage_config` first to check secrets, and indicates when to use `override` for different repo/branch/path. Mentions filtering for large catalogs. However, does not explicitly state when to avoid this tool or how it differs from `list_tokens` for listing tokens.

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