Get system info

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

No annotations are provided, so the description must disclose behavioral traits. It fails to mention that this is a read-only operation with no side effects, required permissions, or rate limits. It only describes the output content vaguely, leaving the agent guessing about safety and impact.

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 sentence front-loads the purpose and uses a concise list structure with quotes for clarity. No unnecessary words; every part adds value.

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 tool's simplicity and lack of output schema, the description adequately hints at return values (version, uptime, page size limits, rate-limit usage). It could optionally mention the output format (e.g., JSON), but not strictly required. Slightly incomplete for a tool with no output schema, hence a 4.

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 describes the single parameter 'type' with enum values. The description adds significant meaning by detailing what each enum value returns: 'status' gives version/uptime, 'pagination' gives page size limits, 'request_rate' gives API rate-limit usage. This goes well beyond the schema's generic 'which system resource to fetch'.

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?

Clearly states 'Get platform system information' and lists three distinct types ('status', 'pagination', 'request_rate') with brief explanations. The tool name and description uniquely identify it among many sibling tools focused on specific CRUD operations.

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 implicitly defines usage by being the only tool for system info. No explicit when/not-to or alternatives are needed as there are no competing siblings. However, it lacks explicit guidance on prerequisites or context, hence not a 5.

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