list_sc_service_users

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

Annotations already declare readOnlyHint=true, so the description doesn't need to state safety. The description adds the filter option but doesn't disclose pagination, default limits, or the constraint that username_starts_with only works with repo_name. These are in the schema, but the description could add value.

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 a single short sentence, front-loading the core purpose. Every word is meaningful, though it could be expanded slightly to include key behavioral details without losing conciseness.

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?

Given the presence of an output schema (handling return values) and 100% schema coverage for parameters, the description covers the basic purpose but omits pagination and filter constraints that impact usage. It is adequate but not thorough.

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?

With 100% schema description coverage, the baseline is 3. The description adds no extra meaning beyond 'Optionally filter by repo', which maps to the repo_name parameter already described in the schema.

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 action ('List') and resource ('service users'), with an optional filter ('by repo'). This distinguishes it from sibling tools like 'get_sc_service_user' (single user) and 'create_sc_service_user' (creation).

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 implies usage for listing multiple users and optionally filtering by repo, but provides no explicit guidance on when to use this tool versus alternatives (e.g., 'get_sc_service_user'), nor any exclusions or prerequisites.

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