Get an assignment
craftboxx_get_assignmentGet one assignment by id. Craftboxx API: GET /assignments/{id}.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| assignment_id | Yes | The assignment id. |
craftboxx_get_assignmentGet one assignment by id. Craftboxx API: GET /assignments/{id}.
| Name | Required | Description | Default |
|---|---|---|---|
| assignment_id | Yes | The assignment id. |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The readOnlyHint annotation already establishes that this is a safe read operation. The description adds only the API endpoint, with no additional behavioral context such as error behavior, permissions, or rate limits.
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 two short sentences with the core purpose front-loaded. The API endpoint sentence is compact and adds a useful mapping without wasting space.
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 simple single-record getter with one fully described parameter and a readOnly annotation, the description is sufficient for correct invocation. It does not explain the returned assignment shape, but no output schema is present and the complexity is low.
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 description coverage is 100%, so the single assignment_id parameter is already fully documented. The description's 'by id' adds only minimal meaning beyond the schema, which is the expected baseline when the schema does the heavy lifting.
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 states a specific verb and resource: get one assignment by id. The phrase 'one assignment by id' distinguishes it from list_assignments, though it does not explicitly name that sibling as the alternative for listing.
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 'by id' phrasing implies this is the tool to use when a specific assignment id is known. However, there is no explicit when-to-use guidance, no exclusions, and no mention of when to use list_assignments instead.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.