Get Form Details

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

Annotations declare readOnlyHint=true, so the safe-read nature is known. The description adds context about the new Jira Forms REST API and the ADF design structure in the return, but lacks details on error behavior, prerequisites, or response format beyond the annotations/output schema.

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, front-loaded with the main purpose and adding relevant context about the API and return content. No wasted 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?

Given the low complexity (2 parameters, no nested objects) and the presence of an output schema, the description is largely complete. It mentions the key output aspect (ADF design structure), though it could have briefly noted that the form is associated with an issue, but the issue_key parameter covers that.

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 documentation coverage is 100%, with both parameters adequately described. The description does not add meaningful semantic details beyond the schema, so baseline 3 is appropriate.

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 'Get detailed information about a specific ProForma form', which is a specific verb+resource. It distinguishes from sibling tools like jira_get_issue_proforma_forms (which lists forms) by emphasizing 'specific form' and 'detailed information'.

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 when needing detailed form info, but does not explicitly mention alternatives or exclusion criteria. No reference to sibling tools such as jira_get_issue_proforma_forms or jira_update_proforma_form_answers, so guidance is only implied.

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