snmp_community_remove

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

With no annotations, the description carries the burden and does well: refusal conditions, the protected configured community, non-persistence ('Does not save'), and an unlock prerequisite are all disclosed. It stops short of saying whether the associated view mapping is also removed or whether a repeat removal is idempotent.

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?

Front-loads the action and then lists constraints in short, separate sentences, with no filler. The clipped style ('Does not save. Gate with hub unlock.') is terse but readable, and every sentence adds a real constraint.

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?

An output schema exists, so return values need no explanation, and the description covers preconditions and side effects for a mutation tool. The remaining gap is the fate of the view mapping and idempotency behavior on an unknown name.

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% for the single 'name' parameter, so the description must compensate; it partly does by constraining the value to a default community, public or private. It does not clarify the exact accepted strings or whether arbitrary names are rejected, leaving the parameter partially documented.

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?

States a specific verb and resource ('Remove an allow-listed default community') plus a scope qualifier ('public or private'), which separates it clearly from snmp_community_create and snmp_user_remove. An agent knows exactly what object this mutates without opening the schema.

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?

Gives concrete preconditions: it refuses unless SWITCH_SNMP_COMMUNITY is present and mapped to a restricted allow-listed view, never removes the configured community, and must be gated with hub unlock. It does not name a sibling alternative for the 'configured community' case, but the when/when-not conditions are explicit.

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