nr_install_module

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

No annotations are provided, so the description must cover behavioral traits. It mentions installation may take 30-60 seconds, which is helpful. However, it lacks details about error handling, idempotency, permissions, or effects on existing modules.

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 two sentences long with no redundancy. The first sentence states the purpose, and the second provides usage guidance and time expectation. Every sentence is necessary and directly contributes.

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 tool's simplicity and the presence of an output schema (which means return values need not be explained), the description covers purpose, pre-installation check, and time estimate. It could mention dependencies or failure modes, but is largely sufficient.

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 one required parameter 'module_name' with 0% coverage from schema description. The description does not explain what constitutes a valid module name or provide examples, leaving the agent without semantic guidance beyond the parameter name.

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 'Install a new Node-RED module (npm package) from the registry.' It uses a specific verb (Install) and resource (Node-RED module) and distinguishes from sibling tools that deal with nodes, flows, and other operations.

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 advises using nr_get_installed_modules to check before installing, and mentions a 30-60 second installation time. It provides a clear when-to-use guideline but does not explicitly state when not to use or list alternatives.

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