octo_search_profiles

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

With no annotations, the description carries the burden of behavioral disclosure. It discloses the auth requirement (OCTO_API_TOKEN) and Cloud API usage, but does not state whether the operation is read-only, how results are returned (e.g., pagination, summary vs. full profiles), or any side effects. The term 'search' implies read-only but not explicitly stated.

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 and efficiently front-loads the core purpose. 'Uses Cloud API' is slightly redundant but not harmful. The auth requirement is useful. Overall, concise and structured well.

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 5 optional parameters and no output schema, the description is incomplete. It does not explain how parameters interact (e.g., AND/OR for tags, how status/ordering affect results), what the return value looks like, or that it is a read-only search. The description leaves significant gaps for the agent to infer.

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% (all 5 parameters have descriptions). The description adds no additional parameter semantics beyond the schema; it only mentions 'partial name or tags' which is already captured by the 'search' and 'tags' parameter descriptions. Baseline 3 is appropriate.

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 the tool searches profiles by partial name or tags, which is a specific verb+resource+method. However, it does not mention the additional filtering capabilities (status, ordering) that are part of the tool's purpose, making it slightly incomplete for full purpose clarity.

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?

No guidance is given on when to use this tool versus alternatives like octo_find_profile_by_name (exact match) or octo_list_profiles (list all). The description implies a search use case but does not explicitly explain exclusions or alternative tools.

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