list_api

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

Disclosures include: endpoints are unlisted drafts (never visible), re-importing shows dry-run diff without duplication, spec fetching uses SSRF-safe proxy, and pricing applies by default. No contradiction with annotations (openWorldHint, non-destructive).

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 coherent paragraph that front-loads the main purpose and then details parameters. Slightly lengthy but every sentence adds value; minor improvement could be structuring with bullet points.

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?

Despite thorough parameter explanations, the description does not mention the return value or output structure. Since there is no output schema, the agent must infer the result (likely a listing ID or confirmation). This omission reduces completeness for a complex tool with many parameters.

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 coverage is 100%, but the description adds significant value beyond schema: spec_url mentions SSRF-safe proxy, tenant_id explains workspace selection, apply_sync clarifies re-import usage, origin_url details overriding behavior, price_sats gives default and minimum, spec_content shows flexibility (inline spec or manual array).

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?

The description clearly states that the tool converts an API spec into a draft bolthub listing, parsing OpenAPI/Swagger/Postman and creating unlisted endpoints with a default price. It distinguishes itself from the sibling tool publish_listing.

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 context on when to use (creating draft from spec) and when not to (publishing is separate). Mentions re-import behavior with dry-run diff and explains tenant_id logic for single vs multiple workspaces.

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