Skip to main content
Glama

invite_user

Add new users to your Portkey organization with specific workspace access and API key permissions for controlled collaboration.

Instructions

Invite a new user to your Portkey organization with specific workspace access and API key permissions

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
emailYesEmail address of the user to invite
roleYesOrganization-level role: 'admin' for full access, 'member' for limited access
first_nameNoUser's first name
last_nameNoUser's last name
workspacesYesList of workspaces and corresponding roles to grant to the user
workspace_api_key_detailsNoOptional API key to be created for the user
Behavior2/5

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

With no annotations provided, the description carries full burden but only mentions what the tool does, not how it behaves. It doesn't disclose whether this sends an email invitation, requires admin permissions, has rate limits, what happens if the user already exists, or what the response looks like. For a user invitation tool with zero annotation coverage, this is a significant gap.

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?

Single sentence that efficiently communicates the core purpose with zero waste. Every word earns its place by specifying the action, target, organization context, and key permission aspects.

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 complex user invitation tool with 6 parameters (including nested objects), no annotations, and no output schema, the description is inadequate. It doesn't explain the invitation workflow, response format, error handling, or permission requirements. The agent would struggle to use this tool effectively without trial and error.

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 parameters thoroughly. The description adds minimal value by mentioning 'workspace access and API key permissions' which aligns with the 'workspaces' and 'workspace_api_key_details' parameters, but doesn't provide additional context beyond what's in the schema. Baseline 3 is appropriate when schema does the heavy lifting.

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 clearly states the action ('invite'), target ('new user'), and scope ('Portkey organization') with specific details about workspace access and API key permissions. It distinguishes from sibling tools like 'add_workspace_member' by focusing on inviting new external users rather than adding existing users to workspaces.

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 description implies usage for inviting new users to the organization, but doesn't explicitly state when to use this vs alternatives like 'add_workspace_member' (for existing users) or 'create_api_key' (standalone API key creation). No guidance on prerequisites, permissions needed, or error conditions is provided.

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/s-b-e-n-s-o-n/portkey-admin-mcp'

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