open_document

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

Without annotations, the description conveys that the file remains open and server starts automatically. It lacks details on side effects, error handling, or authentication requirements, but covers key behavioral traits.

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 relatively concise with six sentences. It front-loads the purpose and lists use cases, though some redundancy exists (e.g., 'for analysis' and then examples).

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?

No output schema is provided, and the description omits return values or status. It also does not address error scenarios like missing files, making it incomplete for a state-modifying tool.

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 coverage is 0%, but description explains language_id with examples. 'file_path' and 'text' are not described beyond their names, leaving some parameters ambiguous.

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 'Open a file in the LSP server for analysis' and lists specific use cases (diagnostics, hover, completions), distinguishing it from sibling tools like close_document or format_document.

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?

It advises to use this tool before other operations and notes that the file remains open until closed, providing good context. However, it does not explicitly state when not to use or mention alternatives.

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