list_profiles

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

With no annotations, the description carries the full burden and does this well: it explicitly discloses idempotence, read-only behavior, absence of confirmation gating, the scraping approach, and the non-null `warning` semantics. It also explains why `profile_type: "UNKNOWN"` is a legitimate reported state rather than a failure, which is valuable behavioral context.

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 dense but every sentence earns its place: purpose first, then behavioral traits, then the warning edge case. It avoids redundancy and keeps the most important information front-loaded.

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 zero-parameter read-only tool, the description covers purpose, safety, edge-case behavior, and the source endpoint. The main gap is that the full return shape and the specific fail-loud assumptions are only referenced via the module docstring rather than included here, so an agent cannot fully self-serve from the description alone.

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?

There are zero parameters, so the schema already completely covers the input side. The description goes beyond the schema by explaining the output-related `warning` and `profile_type` semantics, which is more than the baseline requires.

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?

States a specific verb and resource: 'List every profile OctoBot knows about', which clearly distinguishes it from single-profile operations like get_profile. It also adds that the selected profile is included, giving extra useful scope beyond the name alone.

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?

The description conveys what the tool does and that it is read-only, but it does not explicitly state when to use this tool versus get_profile, select_profile, or other profile-related siblings. Usage context is implied rather than directly spelled out.

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