Get Service

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

Disclosures that environment variables are omitted from the response due to security, which adds transparency beyond annotations. Matches safe read-only behavior indicated by annotations.

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?

Two concise sentences: first explains what it does, second adds usage guidance. No superfluous words.

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 read-only tool with one parameter, description covers included fields and omitted ones. Lacks mention of return format but outputs are likely the configuration object; acceptable without output schema.

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?

Only one parameter (serviceId) with full schema coverage; description adds minimal value by connecting it to list_services, but does not elaborate on format or constraints beyond 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?

Clearly states verb 'Get' and resource 'full configuration of a service' with specific fields like repository, build commands, region, etc. Differentiates from sibling 'list_services' which only returns IDs.

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?

Explicitly guides to use 'list_services' for finding service IDs and mentions that environment variables are managed via partiri CLI (use_partiri_cli). Provides clear context for when to use alternative tools.

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