Skip to main content
Glama

read_survey

Read-onlyIdempotent

List or read surveys. Without survey_id, returns the cross-workspace catalog. With survey_id, returns survey detail — by default links only; pass include for collaborators, blocks, or flow_config. Workspaces that require two-factor authentication are readable only when the connector was approved with two-step verification; otherwise the catalog names any you belong to under hidden_workspaces.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "read_survey"
  }
}

Input Schema

NameRequiredDescriptionDefault
queryNoCatalog search — case-insensitive survey name or workspace label. Omit with survey_id to list every accessible survey.
includeNoWhen survey_id is set, defaults to links only. Pass blocks, flow, or collaborators explicitly when needed. Ignored for catalog-only reads.
survey_idNoSurvey UUID. When set, returns survey detail; omit for cross-workspace catalog.

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.4/5.0
Behavior5/5

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

Annotations already declare readOnly, idempotent, non-destructive and closed-world, yet the description still adds material context beyond them: the default projection is links only, and two-factor workspaces are readable only when the connector was approved with two-step verification, with inaccessible ones surfaced as hidden_workspaces. That auth-gating disclosure is exactly the kind of behavior an agent cannot infer from annotations or schema.

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 sentences, each earning its place: mode selection first, the include projection second, the auth caveat last. No filler and the most decision-relevant information (catalog vs detail) is front-loaded.

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 mode switching, projection defaults and the 2FA access caveat. It stops short of saying whether the cross-workspace catalog is paginated or how large it can get, which is the one remaining operational gap for a list-mode tool.

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 100% and the schema descriptions already state that include defaults to links, that it is ignored for catalog reads, and that query is a case-insensitive name/workspace label match. The description largely restates those same facts, adding little syntax or format detail the schema does not already carry, so the baseline 3 applies.

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 ('List or read surveys') and immediately splits the two behaviors by input shape: no survey_id yields a cross-workspace catalog, survey_id yields detail. An agent can distinguish this from sibling readers like read_block or read_flow because the scope (surveys, cross-workspace) is explicit.

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 when-to-use guidance for both modes and tells the agent when to pass include ('by default links only; pass include for collaborators, blocks, or flow_config'). It does not name a sibling alternative for any case, but the mode selection rules are explicit enough that no inference is required.

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