Skip to main content
Glama

Upsert identity

upsert_identity
DestructiveIdempotent

Upserts a learner by externalId — call this every time you know who the learner is, as often as you like.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNoThe learner's display name; null clears it. Omit to keep the name already stored.
emailNoThe learner's email address; null clears it. Omit to keep the stored one. When set, they are emailed the first time they complete a course.
externalIdYesYour own id for the learner, e.g. your user id. The learner is matched on this, so the same value always updates the same identity.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYes
nameYes
emailYes
isNewYestrue if this call created the identity, false if it updated one already stored.
createdAtYes
externalIdYes
workspaceIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/5.0
Behavior3/5

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

Annotations already include idempotentHint=true, destructiveHint=true, and readOnlyHint=false, so the safety profile is established. The description adds useful context by emphasizing that repeated calls are acceptable, but it does not disclose side effects like clearing fields via null or the destructive overwrite nature beyond what the schema and annotations already imply.

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, compact sentence that front-loads the core action and includes actionable usage guidance. Every clause earns its place, and there is no redundant filler.

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?

For a simple three-parameter tool with a complete schema, rich annotations, and an output schema, the description is nearly sufficient. It clearly communicates the identity-matching behavior and idempotency; the only gap is not explicitly routing multi-record scenarios to the bulk sibling.

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 every parameter is already documented in the input schema. The description does not need to restate parameter details; it adds only the 'by externalId' matching hint, which is also present in the schema's externalId description. This is the baseline where the schema carries the weight.

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 ('Upserts a learner by externalId') and the resource, so an agent knows exactly what the tool does. It does not explicitly name or contrast with sibling tools like bulk_upsert_identities, but the singular 'a learner' and 'by externalId' communicate the core scope.

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

Usage Guidelines4/5

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

The description gives concrete guidance on when to use the tool: 'call this every time you know who the learner is, as often as you like.' It conveys idempotency and frequent safe usage, though it does not explicitly state when not to use it or point to alternatives such as bulk_upsert_identities.

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