get_netshare_afp

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

No annotations provided. Description lists error codes but does not disclose behavior such as whether the config requires enabled service, or what happens if AFP is not configured. The error codes hint at possible failures but are not comprehensive.

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?

Very short description with one line and a list of error codes. Could be more structured (e.g., separate description from error codes). Concise but lacks organization.

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?

Does not explain return value despite having an output schema. No context about AFP protocol or relationship to other network share tools. Minimal completeness for a configuration getter.

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?

Input schema has zero parameters. Description does not add parameter details, but none are needed. Listing error codes adds some value beyond schema.

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?

Description states 'Get the AfpConfig', which is a clear verb+resource. It distinguishes from sibling 'get_netshare_samba' by naming 'AfpConfig' versus 'Samba'. However, it does not explain what AFP is (Apple Filing Protocol), leaving some ambiguity.

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 on when to use this tool vs alternatives like 'get_netshare_samba'. No context about prerequisites or preferred scenarios.

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