get_invitation_link

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

The annotations declare readOnlyHint=true, implying the tool does not modify state. However, the description says it 'Generates' an invitation link and 'Returns the invitation ID', which strongly suggests it creates a persistent invitation record—a write operation. This contradicts the readOnlyHint. Therefore, the description contradicts the annotation.

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 concise, with the main purpose front-loaded and additional parameter details in a compact list. It avoids fluff and is easy to scan, though it could be slightly better structured (e.g., separating parameter explanations from return info). Overall, it is efficient.

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?

Given 4 required parameters and no output schema, the description should provide a complete picture. It omits email and hub_profile_id entirely, does not explain how to obtain hub_profile_id, and gives only a vague return description ('invitation ID and access link URL') without structure. It also lacks any note on permissions or side effects, making it incomplete for safe and correct invocation.

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 explain all parameters. It only clarifies role_id (with numeric mapping) and workspace_id (via list_workspaces()), but leaves email and hub_profile_id unexplained. Since half the required parameters are not described, the description fails to compensate for the schema gap.

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 the tool's function: generating a shareable invitation link for a single email address. It names the primary resource (invitation link) and the scope (single email). It does not explicitly distinguish it from the sibling tool get_workspace_invitation_link, though the mention of 'single email address' hints at a difference, but that differentiation is not made explicit.

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?

The description provides some context on how to obtain workspace_id (from list_workspaces()) and defines role_id values, which helps usage. However, it does not state when to use this tool versus alternatives like get_workspace_invitation_link or invite_to_workspace, nor any exclusions or prerequisites (e.g., permission requirements). Guidance is implied rather than explicit.

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