inventory__get_workspace

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

Annotations declare readOnlyHint=true, and the description aligns with that by stating 'Get details' and listing returned fields. The description adds value by disclosing the required permission ('inventory:groups:read (Workspace viewer)') and the exact return fields, which goes beyond the annotation. No contradiction.

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 and front-loaded. The first sentence states the core purpose, the second lists return fields, and the third gives permission and usage guidance. Every sentence earns its place with no redundancy.

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?

The description is complete for a read-only lookup tool. It covers purpose, input format, return fields, and permission requirements. The output schema exists, so return values are already structured. The only minor gap is not explicitly stating when to use this over inventory__list_workspaces, but the ID-based lookup is clear enough.

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 schema already documents the parameter. The description adds meaning by explaining the comma-separated format and the preference for IDs over names, which is not in the schema. This compensates well for the single parameter.

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 the tool's function: 'Get details for one or more workspaces by ID.' It specifies the resource (workspaces), the action (get details), and the input method (by ID). It also lists the returned fields, which distinguishes it from sibling tools like inventory__list_workspaces.

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 when to use this tool: when you need details for specific workspaces by ID. It doesn't explicitly exclude alternatives, but the presence of sibling inventory__list_workspaces and the focus on ID-based lookup provides clear context. It also gives a practical guideline: 'Prefer IDs over names; names can be duplicated.'

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