sdcloud_get_ipsec_profile

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

With no annotations, the description must fully disclose behavior. It only states 'Get an IPsec profile by name' without mentioning whether the profile must exist, error handling (e.g., 404 if not found), or that it is read-only. The agent is left guessing about side effects or existence requirements.

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?

Single sentence, no superfluous words. Information is front-loaded and directly addresses the tool's purpose.

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?

For a simple getter with no output schema, the description might be minimally adequate, but it lacks mention of return type, format, or common error cases. The agent cannot fully anticipate the tool's output or behavior.

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%, requiring the description to add meaning to profile_name. The description adds nothing beyond the parameter name itself. No format, constraints, or examples are provided. The agent has no guidance on what constitutes a valid profile name.

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 clearly states the verb 'Get' and resource 'IPsec profile', with identifier method 'by name'. This distinguishes it from sibling tools like list_ipsec_profiles (for listing all) and create/update/delete.

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 versus alternatives. Does not mention that list_ipsec_profiles is for retrieving multiple profiles, or that this returns a single profile. No when-not-to-use or prerequisite information.

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