ppp_secrets

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

The note about credentials hints at sensitivity, but there is no disclosure of read-only behavior or authentication requirements. Since no annotations are provided, the description should compensate but fails to do so.

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 extremely concise: two short sentences. The first sentence conveys the core purpose, and the second adds a critical note. No unnecessary words.

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 description lists three fields but does not specify if there are more or if there is any ordering/filtering. With no output schema, more detail would be helpful, but for a simple list tool it is minimally adequate.

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 are no parameters, so schema coverage is 100%. The description adds value by listing the output fields (name, service, profile), which helps the agent understand what data will be returned.

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 it lists PPP accounts (PPPoE/VPN) and specifies the fields (name, service, profile). It distinguishes itself from sibling tools like 'ppp_active' and 'ppp_profiles' by focusing on secrets/credentials.

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?

No guidance is given on when to use this tool versus siblings like 'ppp_active' or 'add_ppp_secret'. The description does not mention prerequisites or context for use.

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