Skip to main content
Glama

user_invite

Send email invitations to new users and optionally grant product access. Manage user onboarding through the MCP Pickaxe Server.

Instructions

Send email invitations to new users with optional product access.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
studioNoStudio name to use. Available: STAGING, MAIN, DEV, PRODUCTION. Default: PRODUCTION
emailsYesArray of email addresses to invite
productIdsNoArray of product IDs to grant access to

Implementation Reference

  • src/index.ts:376-396 (registration)
    Tool registration for 'user_invite', including name, description, and input schema definition.
    {
      name: "user_invite",
      description: "Send email invitations to new users with optional product access.",
      inputSchema: {
        type: "object",
        properties: {
          studio: studioParam,
          emails: {
            type: "array",
            items: { type: "string" },
            description: "Array of email addresses to invite",
          },
          productIds: {
            type: "array",
            items: { type: "string" },
            description: "Array of product IDs to grant access to",
          },
        },
        required: ["emails"],
      },
    },
  • Input schema for the 'user_invite' tool defining parameters: studio (optional), emails (required array), productIds (optional array).
    inputSchema: {
      type: "object",
      properties: {
        studio: studioParam,
        emails: {
          type: "array",
          items: { type: "string" },
          description: "Array of email addresses to invite",
        },
        productIds: {
          type: "array",
          items: { type: "string" },
          description: "Array of product IDs to grant access to",
        },
      },
      required: ["emails"],
    },
  • Handler for 'user_invite' tool: sends POST request to Pickaxe API /studio/user/invite with emails and productIds, returns JSON response.
    case "user_invite": {
      const result = await pickaxeRequest("/studio/user/invite", "POST", {
        emails: args.emails,
        productIds: args.productIds,
      }, studio);
      return JSON.stringify(result, null, 2);
    }
Behavior2/5

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

With no annotations provided, the description carries full burden for behavioral disclosure. While it indicates this sends emails (an external action) and grants product access (a permission change), it doesn't disclose important behavioral aspects like whether this requires admin permissions, what happens if emails are invalid, whether invitations can be resent, rate limits, or what the expected response looks like. For a tool with mutation capabilities and no annotation coverage, this is insufficient.

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?

The description is a single, efficient sentence that communicates the core functionality without unnecessary words. It's front-loaded with the main action and includes the key qualification about optional product access. Every word earns its place in this concise formulation.

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

Completeness2/5

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

For a tool that performs user invitations (a mutation with external email effects) with no annotations and no output schema, the description is incomplete. It doesn't explain what happens after invocation - whether users receive immediate emails, what the invitation contains, whether there are confirmation steps, or what the tool returns. The description should provide more context about this non-trivial operation.

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 the schema already documents all three parameters thoroughly. The description adds minimal value beyond the schema - it mentions 'optional product access' which aligns with the optional productIds parameter, but doesn't provide additional context about parameter interactions, default behaviors, or usage patterns. Baseline 3 is appropriate when the schema does the heavy lifting.

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

Purpose4/5

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

The description clearly states the action ('Send email invitations') and target ('to new users'), with additional context about optional product access. It distinguishes from siblings like user_create or user_update by focusing specifically on invitation functionality rather than user record management. However, it doesn't explicitly differentiate from all sibling tools like user_get or user_list.

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

Usage Guidelines2/5

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

The description provides no guidance on when to use this tool versus alternatives like user_create (which might create users without invitations) or user_update (which might modify existing users). There's no mention of prerequisites, limitations, or typical scenarios for sending invitations versus other user management operations.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/aplaceforallmystuff/mcp-pickaxe'

If you have feedback or need assistance with the MCP directory API, please join our Discord server