Skip to main content
Glama

Regenerate External Panel Entry Token

regenerate_external_panel_token
Destructive

Replace the external-panel entry token for an owned BYOP study. The old provider link stops working immediately; update the provider with the returned entry_url. Supply a unique idempotency_key and reuse it after an uncertain response; inspect the current link with get_external_panel if the replay is stale.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
study_idYes
idempotency_keyNoReuse the same key and inputs if a prior call timed out. A different operation needs a new key.
organization_idNoPlatform admins only: select an organization for this operation. Required when changing another organization’s study or using its wallet.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYesConfiguration with a new entry URL.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / organization_id
      Added value: +{
      +  "description": "Platform admins only: select an organization for this operation. Required when changing another organization’s study or using its wallet.",
      +  "maxLength": 128,
      +  "minLength": 1,
      +  "type": "string"
      +}
  2. Added

TDQS

A4.7/5.0
Behavior5/5

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

Annotations declare destructiveHint=true and idempotentHint=false, but the description adds the crucial consequence the annotations cannot convey: the old provider link stops working immediately and the caller must update the provider with the returned entry_url. That is exactly the kind of beyond-annotation detail an agent needs before invoking a destructive op.

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 tight sentences, front-loaded with the destructive consequence, then recovery guidance. No filler or restated boilerplate.

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

Completeness5/5

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

With annotations covering the safety profile, an output schema covering return values, and the description covering the destructive side effect and idempotency recovery, an agent has everything needed to invoke this correctly. Nothing material is missing.

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 coverage is 67%, with idempotency_key and organization_id already documented in the schema. The description reinforces the idempotency_key contract (unique, reuse after an uncertain response) and implies study_id refers to an owned BYOP study, adding value beyond the schema without contradicting it.

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 ('Replace the external-panel entry token') and scopes it ('for an owned BYOP study'). An agent can distinguish this from siblings like configure_external_panel or get_external_panel without opening any schema.

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?

Gives clear operational direction -- supply a unique idempotency_key, reuse it after an uncertain response, and inspect with get_external_panel if the replay is stale. It names a sibling alternative, though it frames the alternatives around replay recovery rather than a broad when-to-use-this-vs-configure_external_panel rule.

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