netmiko.get_metadata

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

No annotations are provided, so the description bears full responsibility. It discloses that the tool does not reach any network device, explains the returned fields (version, author, inventory, command_policy, etc.), and details the meaning of the command_policy field including the warning behavior. This fully compensates for missing annotations.

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 longer than average but each sentence adds essential information. It is front-loaded with the core purpose and mandatory call order, then provides behavioral details and return format. While slightly verbose, the structure is logical and the length is justified by the complexity of guidance needed.

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 absence of annotations, the presence of an output schema (context signals), and zero parameters, the description fully covers all necessary aspects. It explains when to call, what it returns, the significance of inventory freshness, the command_policy states, and how to handle warnings. There is no missing information for an agent to use this tool correctly.

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 zero parameters, so schema description coverage is 100% trivially. The description does not need to explain parameters. It adds value by detailing the output fields and their significance, which is a bonus. Baseline for zero parameters is 4.

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 'Return authoritative metadata about the Netmiko MCP server and its inventory.' This is a specific verb+resource combination. It distinguishes itself from sibling tools like netmiko.health_check (server aliveness) and netmiko.send_show_command (device queries) by explaining what it does not do.

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 explicitly demands: 'MANDATORY — call this tool FIRST on EVERY user message that mentions, asks about, or relates to network devices...' It provides concrete context for when to use it (first call for device-related queries) and when not to (e.g., 'This tool does NOT reach any network device. For "is the MCP alive" call netmiko.health_check'). This is exemplary usage guidance.

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