ms_read_local_help_page

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

With no annotations provided, the description carries the burden of disclosing behavior. It does state that the tool extracts 'cleaned text and code examples', which gives some insight, but it lacks details on error handling, path validity, or the nature of the cleaning process. The read-only nature is implied but not explicit.

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 that front-loads the action and resource. Every word contributes meaning without redundancy, making it highly efficient for an agent to parse.

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?

The tool is simple (one parameter) and has an output schema that likely describes return values, so low complexity helps. However, the description never mentions prerequisites (e.g., a local installation or installation detection) or what to do if the path is invalid. Without annotations, these gaps reduce completeness for a standalone operation.

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 input schema has 0% description coverage for the single 'path' parameter, so the description must compensate. It merely refers to 'specific local Materials Studio help page', which clarifies the path is a local file path but adds no format, extension, or resolution details. Minimal value added beyond the parameter name itself.

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 'read' and the specific resource 'local Materials Studio help page', and specifies the action of extracting cleaned text and code examples. It distinguishes itself from sibling tools like ms_search_local_help by focusing on reading a specific page rather than searching for pages.

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 usage when a practitioner already knows the path to a specific help page, but it does not explicitly state when to use this tool over ms_search_local_help or ms_find_code_examples. There is no mention of alternative tools or exclusions, so guidance is only implicit.

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