Get Workspace

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

The description does not disclose any behavioral traits beyond the obvious 'get' action. While annotations confirm read-only and non-destructive behavior, the description itself adds no additional context about side effects, errors, or permissions.

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 concise sentence with no unnecessary words or repetition. It efficiently conveys the essential purpose in a minimal, well-structured format.

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?

Given the simplicity of the tool (single parameter, read-only), the description covers the basic purpose, but it omits any mention of the return value or potential error cases. Since there is no output schema, a brief note about expected output would improve completeness.

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 description clarifies that the workspace is identified 'by slug', directly explaining the meaning of the 'workspaceSlug' parameter. This adds value beyond the schema, which only lists the parameter name and type without any description.

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 verb 'Get' and the resource 'workspace by slug', making it distinct from sibling tools like listWorkspaces or checkWorkspaceSlug. It specifies the scope of retrieval by slug, leaving no ambiguity about what the tool does.

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 provides no guidance on when to use this tool versus alternatives such as listWorkspaces (for multiple workspaces) or checkWorkspaceSlug (for availability checking). It is left to the agent to infer usage context from the parameter and sibling names.

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