read_workspace

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

With no annotations provided, the description takes on the transparency burden. It discloses that unknown or other-tenant IDs return 404, which is a meaningful behavioral and security-tied detail beyond the basic retrieval function. This is valuable context for the agent. It doesn't mention auth requirements or side effects, but for a read tool with no side effects, this is adequate.

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 a single sentence that immediately states the action and key behavior. Every word earns its place, and the 404 detail is concise and relevant. No fluff or repetition.

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 read tool with one parameter and an output schema present, the description is fully complete. It covers the core function, ID requirement, and error case. The output schema handles return-value details, so nothing else is needed.

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?

The input schema already has 100% coverage with an 'id' parameter described as 'Workspace ID.' The description adds only the phrase 'by ID', which reinforces the schema's meaning but doesn't add new semantic depth. With high schema coverage, the baseline of 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 'Returns a single workspace by ID', which is a specific verb+resource and distinguishes this from sibling tools like list_workspaces and create_workspace. The scope is also clarified with 'single workspace' and the 404 behavior adds precision.

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 you have a workspace ID and need the single workspace, but it doesn't explicitly contrast with list_workspaces or mention when not to use it. The 404 note gives context that IDs from other tenants are not accessible, which helps usage, but no alternative tools are named.

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