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

NameRequiredDescriptionDefault
study_idYes
organization_idNoOrganization for this operation and billing. Use list_organizations to choose an active membership.

Output Schema

NameRequiredDescriptionDefault
resultYesExternal-panel entry and outcome configuration.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / organization_id / description
      Previous value: -"Platform admins only: select an organization for this operation. Required when changing another organization’s study or using its wallet."New value: +"Organization for this operation and billing. Use list_organizations to choose an active membership."
  2. 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"
      +}
  3. Added

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false and openWorldHint=false, so the safety profile is covered. The description adds the meaningful scoping constraint that the study must be owned and of BYOP type, but it says nothing about behavior when the study is not a BYOP study, whether missing configuration returns empty or errors.

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?

Two sentences, zero waste. The positive definition comes first and the disambiguation follows, which is exactly the right front-loading for a routing decision.

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?

An output schema exists so return values need no explanation, and the description nonetheless enumerates the three returned artifacts. Annotations cover the safety profile. The only gap is error/edge-case behavior for non-BYOP or unconfigured studies, which is minor for a simple two-parameter read.

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 coverage is 50%: organization_id is documented in the schema while study_id has only a UUID pattern. The description partially compensates by implying study_id must reference an owned BYOP study, which adds semantics beyond the bare UUID format. It adds nothing about organization_id or billing implications.

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?

States a specific verb ("Read") and resource (external panel configuration: entry link, respondent ID parameters, outcome redirects) scoped to one owned BYOP study. It explicitly says what it is not (individual BYOP invitations, paid User Intuition Panel recruitment), though the closest siblings in the list — configure_external_panel and regenerate_external_panel_token — are not named.

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?

"For one owned BYOP study" implies the prerequisite context (ownership, BYOP study type) and the second sentence excludes two adjacent concepts. However, no explicit when-to-use vs. configure_external_panel, delete_external_panel, or regenerate_external_panel_token is given, so an agent must infer that this is the read-only counterpart to the configure/delete siblings.

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