neon3_nui_reference

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

With no annotations provided, the description carries the full burden of behavioral disclosure. The verb 'Read' indicates a non-mutating operation, which is helpful, but it does not describe the return format, whether any side effects occur, or any prerequisites. For a read-only look-up tool, this is acceptable but not exhaustive.

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 concise—two short sentences—and front-loads the core action ('Read') followed by a list of topics. It avoids unnecessary detail and is easy to scan, but a bulleted list could slightly improve structure.

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 simplicity of the tool (one enum parameter, no output schema), the description provides the essential topics and a clear action. However, it omits details about what the response will contain, such as the format or extent of the reference text, which an agent might need to set expectations. With no annotations and no output schema, this gap is notable.

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?

There is only one parameter ('topic') with an enum, and the description explicitly lists the same topics ('overview, grammar, components, statecharts, interactions, diagnostics'). This reinforces the schema and adds clarity about the valid values, compensating for the schema description coverage of 0% by providing the enum values in prose.

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 action ('Read') and the resource ('authoritative Neon3 NUI Flow V1 reference'), making the purpose unambiguous. It lists the topics covered, which helps differentiate it from action-oriented siblings like neon3_nui_validate or neon3_nui_inspect, but it does not explicitly name or contrast with those siblings.

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 reference material on NUI Flow topics, but it provides no explicit guidance on when to choose this tool over alternatives. It neither lists exclusions nor names sibling tools that might be better suited for other tasks, leaving the agent to infer usage context.

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