Get host

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

Beyond the annotations, the description discloses important behavioral details: it returns None for an unknown alias and raises PermissionError when the alias exists but the caller is not entitled to it. It does not describe the successful return shape, but it adds meaningful auth and fallback context.

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 reasonably front-loaded, starting with the core purpose before the return and exception behavior. It is slightly verbose with parenthetical fallback context, but every sentence provides useful operational detail.

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 one-parameter read-only lookup with rich annotations, the description covers the key failure modes and fallback behavior. The main remaining gap is that it does not describe the successful return value beyond calling it a "host config."

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 description coverage is 0%, so the description must carry the burden for the single alias parameter. It clarifies that alias identifies a host config and distinguishes unknown aliases from unauthorized aliases, but it does not specify alias format or case sensitivity.

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 states a specific verb and resource: "Get a host config by alias." It is clear what the tool retrieves, but it does not explicitly distinguish itself from siblings such as tunnel_manager_list_hosts or tunnel_manager_add_host.

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?

Usage is implied by the alias-based lookup and by the note that unknown aliases cause callers to fall back to raw connection params. However, it does not explicitly say when to use this instead of tunnel_manager_list_hosts or other host-management siblings.

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