Skip to main content
Glama

Invite collaborator

invite_collaborator
Idempotent

Invite a collaborator by NotePom username or email. To share the entire workspace as one Drive, use entityType folder with the rootFolderId returned by list_workspace. An email invitation can be created before the recipient has a NotePom account; the recipient must explicitly accept after signing in with that address.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
entityIdYes
identityYesA NotePom username or an email address. Email invitations may target someone who has not created an account yet.
languageNoBCP 47 language for an invitation recipient without a saved NotePom preference.
entityTypeYes
workspaceIdYes
idempotencyKeyYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYes
emailNo
expiresAtYes
deliveryStatusYes
recipientUserIdNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / language
      Added value: +{
      +  "description": "BCP 47 language for an invitation recipient without a saved NotePom preference.",
      +  "maxLength": 32,
      +  "minLength": 1,
      +  "type": "string"
      +}
  2. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "http://json-schema.org/draft-07/schema#",
      +  "additionalProperties": false,
      +  "properties": {
      +    "deliveryStatus": {
      +      "enum": [
      +        "pending",
      +        "sent",
      +        "failed"
      +      ],
      +      "type": "string"
      +    },
      +    "email": {
      +      "format": "email",
      +      "type": "string"
      +    },
      +    "expiresAt": {
      +      "format": "date-time",
      +      "type": "string"
      +    },
      +    "id": {
      +      "format": "uuid",
      +      "type": "string"
      +    },
      +    "recipientUserId": {
      +      "format": "uuid",
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "id",
      +    "deliveryStatus",
      +    "expiresAt"
      +  ],
      +  "type": "object"
      +}
  3. Changed1 schema field changed
    • addedInput schema / properties / identity / description
      Added value: +"A NotePom username or an email address. Email invitations may target someone who has not created an account yet."
  4. First observed

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=false, destructiveHint=false, idempotentHint=true, and openWorldHint=true, so the description doesn't need to restate those. It adds meaningful behavioral context: email invitations can be created before the recipient has an account, and the recipient must explicitly accept after signing in. This goes beyond the schema and annotations, though it doesn't detail side effects like whether an existing collaborator is replaced or whether the invitation expires.

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

Conciseness5/5

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

Three sentences, each carrying distinct information: the core action, the workspace-sharing special case, and the email-invitation behavior. No filler or repetition of schema fields. The most important scoping information is front-loaded.

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?

The tool has an output schema, so return values don't need explanation. The description covers the main behavioral nuances (email pre-account invitations, explicit acceptance, whole-workspace sharing). It could be more complete by noting what happens on duplicate invitations or whether the idempotencyKey prevents duplicates, but for an invitation tool with annotations and an output schema, this is largely sufficient.

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

Parameters4/5

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

Schema description coverage is only 33%, so the description must compensate. It does clarify the key parameter semantics: identity can be a username or email, entityType folder with rootFolderId enables whole-workspace sharing, and email invitations can target pre-account users. However, it doesn't explain workspaceId, idempotencyKey, or language beyond what the schema already says, so it doesn't fully cover the gap.

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?

The description states a specific verb ('Invite') and resource ('collaborator by NotePom username or email'), and distinguishes the tool from siblings like revoke_collaboration_invitation and accept_collaboration_invitation. It also clarifies the two entity types and the special case of sharing the entire workspace as a Drive, which makes the tool's purpose unmistakable.

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

Usage Guidelines5/5

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

The description explicitly tells when to use this tool (invite by username or email) and gives a concrete alternative path for sharing the whole workspace (entityType folder with rootFolderId from list_workspace). It also explains the email-invitation flow for recipients without an account, which is essential usage context not inferable from the schema.

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