pipeshub_sources

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

Annotations already indicate read-only, idempotent, non-destructive behavior. The description adds valuable behavioral context beyond that: the 1,000-source truncation flag, conditional embedding-model fetching, and caching advice. No contradiction with annotations.

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?

The description is front-loaded with the one-line purpose, then organized into clear bullets for each section. Every sentence earns its place; there is no filler or repetition of annotation data.

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?

For a tool with zero required parameters, no output schema, and comprehensive annotations, the description covers all critical information: what sections exist, their contents, defaults, truncation semantics, downstream usage, and caching recommendation. Nothing necessary for correct invocation is missing.

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?

While the schema already documents the include enum with a default, the description enriches meaning by showing how each section is consumed elsewhere (connector ids in apps, collection ids in kb, modelKey on chat, isDefault selection). This goes beyond the schema's basic parameter documentation.

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?

Description opens with a specific verb and resource: 'Discover available chat sources and AI models in one call.' It then enumerates the three returned sections, each tied to concrete downstream use (e.g., modelKey for pipeshub_chat), clearly distinguishing this discovery tool from its siblings.

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?

Gives explicit usage guidance: 'Call this once at the start of a session and cache the result' and says to add embeddingModels only when configuring re-embedding. It also explains how returned ids and modelKeys flow into pipeshub_search and pipeshub_chat, so an agent knows exactly when to invoke this tool.

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