get_assignment_action

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

Despite no annotations, the description adds important behavioral context: 'If the case type uses pessimistic locking and the client uses Constellation, this request may lock the case.' It also specifies that it retrieves details for ONE specific action. However, it does not explicitly state that the tool is read-only or idempotent, which would further improve transparency.

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 concise (5 sentences) with no wasted words. It is front-loaded with purpose and usage, then covers parameters efficiently. Every sentence 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?

There is no output schema, yet the description only mentions 'including UI metadata and preprocessing execution' without detailing the response structure. For a tool retrieving detailed action info, it would benefit from outlining what fields or data are returned (e.g., similar to get_assignment). It is adequate but incomplete.

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 100%, so baseline is 3. The description significantly enhances parameter understanding: explains actionID case sensitivity and relation to display names, gives example for assignmentID, clarifies viewType options, and describes sessionCredentials authentication modes. This goes well 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?

The description clearly states 'Get detailed information about a specific action that can be performed on an assignment.' It uses a specific verb ('Get') and identifies the resource ('assignment action'). It also differentiates from sibling tools by outlining the typical workflow where get_assignment is preferred.

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?

Provides explicit guidance: 'Often optional - most workflows use: get_assignment (all actions + eTag) → perform_assignment_action. Use this when you need action-specific details.' It also instructs to use get_assignment to find the correct action ID, setting clear usage context.

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