edgegate_list_api_keys

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

With no annotations, the description carries the full burden. It discloses that plaintext API keys are never returned, requires owner role (authentication), and lists output fields. It does not mention pagination or rate limits, but gives substantial behavioral context for a read-only list operation.

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 two sentences, front-loaded with purpose, and every sentence adds value: return fields, privacy guarantee, and role requirement. No filler or repetition.

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 simple list tool with one parameter and no output schema, the description covers the essential semantics: purpose, fields returned, auth requirement, and a key privacy note. It could mention pagination or response format, but the essentials are present.

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?

The only parameter, workspace_id, is not explicitly mentioned in the description. The phrase 'in this workspace' implies it but adds no new meaning beyond the schema's name and format. Schema coverage is 0%, and the description does not compensate by explaining how to obtain or use the workspace_id.

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 'List all API keys in this workspace' with a specific verb (list), resource (API keys), and scope (workspace). It also lists the returned fields (id, name, prefix...suffix, status, last_used), distinguishing it from related tools like create/revoke API keys.

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 clear context by specifying the operation is scoped to 'this workspace' and requires 'owner role'. However, it does not explicitly mention when to avoid using this tool or recommend alternatives, though the usage context is obvious.

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