Get Finding

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

The description is minimal; it does not disclose behavioral traits such as read-only nature, authorization requirements, or whether it returns a full object. No annotations are present to fill the gap.

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 extremely concise at one sentence. It is front-loaded with the core purpose, but omits valuable context that could be added without sacrificing brevity.

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 no output schema and many sibling tools, the description should indicate what 'full details' includes or how the response is structured. The current text is too vague to fully inform an agent's decision.

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 0%, but the parameter 'findingId' with type integer and exclusiveMinimum is self-explanatory. The description adds 'by ID' which confirms usage but provides no additional semantic detail over 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 'Full finding details by ID' clearly states the verb ('get') and resource ('finding'), and implies retrieval by ID. It distinguishes from sibling tools like 'armorcode_search_findings' (list/search) but does not explicitly explain the scope or uniqueness.

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 on when to use this tool versus alternatives like 'armorcode_search_findings' or 'armorcode_get_finding_events'. No when-not-to-use or prerequisite information provided.

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