Read issue workspace file content

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

Annotations already declare readOnlyHint, idempotentHint, etc., and the description adds only 'Authorization class: board.' No additional behavioral traits (e.g., error handling, file existence behavior) are disclosed. This is adequate but minimal.

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 extremely concise (two sentences, no fluff), but it sacrifices necessary detail. For a tool with zero schema descriptions, this structure is too sparse.

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 presence of an output schema, nested parameters, and multiple optional fields, the description is insufficient. It doesn't explain what the output contains, how workspace selection works, or how this tool fits into the file resource workflow.

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 0%, so the description must compensate, but it provides no explanation of any parameter. The query parameters (path, projectId, workspace, workspaceId) are entirely unexplained, leaving the agent without guidance on how to use them.

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 repeats the title verbatim and adds the HTTP path, but it doesn't distinguish this tool from siblings like 'list' or 'resolve' beyond the name. It lacks specificity about what 'content' means (text, binary, etc.).

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 use this tool versus alternative file-related tools (list, resolve). No when-to-use or when-not-to-use context provided.

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