Skip to main content
Glama

Get External Panel Configuration

get_external_panel
Read-onlyIdempotent

Read the customer-supplied panel entry link, respondent ID parameters, and outcome redirects for one owned BYOP study. This is distinct from individual BYOP invitations and paid User Intuition Panel recruitment.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
study_idYes
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
resultYesExternal-panel entry and outcome configuration.

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

A3.8/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, openWorldHint=true, destructiveHint=false, so the safety profile is covered. The description adds the useful ownership constraint ('one owned BYOP study') and specifies what content is returned, but says nothing about auth requirements, rate limits, or behavior when the study has no external panel configured.

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

Conciseness4/5

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

Two compact sentences with the read action and scope front-loaded, followed by the disambiguation clause. No filler, though the second sentence's distinction could be slightly tighter.

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?

With an output schema present, return values need not be explained, and the description covers purpose, scope, and differentiation adequately for a 2-parameter read tool. The only gap is the undocumented required study_id parameter and lack of any error/edge-case note.

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

Parameters2/5

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

Schema description coverage is only 50%: organization_id is documented as platform-admin-only, but study_id carries no description in either schema or description text. The description adds no parameter-level meaning (e.g., what counts as an owned study, UUID format expectations), so it does not compensate for the coverage 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 names a specific verb (Read) and resource (customer-supplied panel entry link, respondent ID parameters, outcome redirects) scoped to one owned BYOP study. It explicitly differentiates from sibling tools configure_external_panel/delete_external_panel and from separate concepts (individual BYOP invitations, paid Panel recruitment), so an agent can identify it without opening a 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?

It clearly states the disambiguation context ('This is distinct from individual BYOP invitations and paid User Intuition Panel recruitment'), which helps an agent route correctly. However, it stops short of naming the directly competing siblings (configure_external_panel, delete_external_panel, regenerate_external_panel_token) or stating the read-vs-write selection condition explicitly.

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