get_workspace

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

Annotations already indicate readOnlyHint and openWorldHint, setting a low bar. The description adds that details include 'tabs and lists', which is useful content context, but it does not disclose other behavioral aspects like error handling or permission requirements. It adds some value beyond annotations but is not rich.

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 with a clear verb-object structure, no fluff, and front-loaded content. Every word earns its place, making it appropriately concise.

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?

This is a simple get-by-sys_id tool with one parameter, good annotations, and no output schema. The description adequately conveys the main purpose and content scope ('tabs and lists'), which is sufficient for a getter. It could mention error cases but is not necessary for basic 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 schema covers 100% of parameters, and the description adds no extra meaning for sys_id beyond the schema's 'Workspace sys_id'. The baseline of 3 applies because the schema does the heavy lifting; the description does not compensate or add detail.

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 uses a specific verb 'Get' and resource 'workspace', and clarifies it includes 'tabs and lists', distinguishing it from siblings like list_workspaces (which lists) and create_workspace. This is a precise and informative purpose statement.

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 the tool is for retrieving details of a single workspace by sys_id, but it does not explicitly state when to use this versus alternatives like list_workspaces or configure_workspace_list. There is no mention of exclusions or alternative tools.

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