Show the workspace

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

Annotations already establish readOnlyHint=true, idempotentHint=true, and openWorldHint=false, so safety and repeatability are covered. The description adds the useful fact that a workspace may be a local directory or a checkout and that it is changeable, but says nothing about the response shape or where the setting is stored.

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?

A single compact sentence that front-loads the core concept. It is a sentence fragment and slightly elliptical ('how to change it' is ambiguous), but it wastes no 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?

For a zero-argument read-only tool with no output schema, the description does not say what the call actually returns (a path, a config block, instructions?) or how 'changing it' relates to this tool versus a separate setter. Adequate but with a clear gap for an agent deciding whether to call it.

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 tool takes zero parameters, so there is no parameter semantics to document; the 4 baseline applies. Nothing in the description misleads about inputs.

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 explains the concept of a workspace ('where entries are saved... your own directory, or a platform-mcp checkout when contributing'), which clarifies the domain, but it never states the action the tool performs. An agent must infer 'show' from the title alone; the description reads like documentation of a concept rather than a statement of what this call returns.

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?

No guidance on when to invoke this versus siblings like doctor, catalog_search, or read_docs. The parenthetical about 'when contributing' hints at a scenario but doesn't tell the agent when it should call workspace at all.

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