Skip to main content
Glama

invite_by_email

Owner only. Invite a person (or their AI assistant) to a private workspace by email. hashn emails them a link with plain steps any assistant can follow (sign up, then redeem the invite), and they can also just reply to the email to sign up and join by email. Optional short note (shown as yours, links removed). Single use, like create_invite.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
noteNoOptional short note to the person, shown as yours; links are removed.
emailYesThe person's email address. hashn keeps only a hash of it and a hint (first letter and domain).
api_tokenNoYour hashn API token, if you can't send it as the 'Authorization: Bearer <token>' header. Omit it when the header is set.
workspace_idYesThe workspace's id (a UUID), from create_workspace, list_workspaces or the store.
expires_in_hoursNoHow long the invite stays valid, in hours. Omit for the default.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changed
    • addedInput schema / properties / api_token / description
      Added value: +"Your hashn API token, if you can't send it as the 'Authorization: Bearer <token>' header. Omit it when the header is set."
    • addedInput schema / properties / email / description
      Added value: +"The person's email address. hashn keeps only a hash of it and a hint (first letter and domain)."
    • addedInput schema / properties / expires_in_hours / description
      Added value: +"How long the invite stays valid, in hours. Omit for the default."
    • addedInput schema / properties / note / description
      Added value: +"Optional short note to the person, shown as yours; links are removed."
    • addedInput schema / properties / workspace_id / description
      Added value: +"The workspace's id (a UUID), from create_workspace, list_workspaces or the store."
  2. Added

TDQS

A3.8/5.0
Behavior4/5

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

Annotations cover the safety profile (readOnly=false, destructive=false), so the description correctly focuses on what the agent can't infer: an email is sent, it is single-use, and the optional note is displayed as the sender's with links stripped. This is meaningful side-effect disclosure, though it doesn't clarify permissions beyond 'Owner only' or delivery/rate behavior.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The purpose and 'Owner only' constraint are correctly front-loaded, but the middle sentence drifts into verbose workflow detail ('plain steps any assistant can follow ... reply to the email to sign up and join by email') that an agent doesn't need to invoke the tool.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With annotations present and an output schema absent, the description supplies the key behavioral context (single-use, email-based, owner-only, note handling). It is largely complete for a 5-parameter invite tool, missing only explicit return/confirmation behavior.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so all five parameters (note, email, api_token, workspace_id, expires_in_hours) are already documented in the schema. The description's mention of the note ('shown as yours, links removed') merely restates the schema, so the baseline of 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Invite a person ... to a private workspace by email') plus scope and permission ('Owner only'). It also positions itself against a sibling by noting the behavior is 'single use, like create_invite', letting an agent distinguish it without opening either schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The 'Owner only' prefix is a genuine precondition, and 'single use, like create_invite' hints at the relationship with the alternative. However, it never explicitly states when to use this versus create_invite (or the other invite siblings), leaving the routing to inference.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources