Skip to main content
Glama

list_visuals

Retrieve report visuals with their titles, types, and field bindings, and filter by page, workspace, or search term to inspect and troubleshoot report layouts.

Instructions

List visuals in the report with their titles, types, and field bindings.

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": "list_visuals"
  }
}

Input Schema

NameRequiredDescriptionDefault
pageNoOptional page ID or display name filter.
queryNoOptional search term matching visual title, visual type, ID, or bound field.
workspaceNoWorkspace identifier returned by list_workspaces (prefer workspace_id or unique name). Optional when the server is bound to a single workspace.

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

B3.2/5.0
Behavior3/5

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

No annotations exist, so the description carries the full behavioral burden. "List" implies a non-mutating read and the sentence names the fields returned, but nothing is said about pagination, result limits, permissions, or whether large reports are truncated. It is directionally correct but thin for a zero-annotation tool.

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?

One front-loaded sentence with no filler, which is appropriate for a simple list operation, though the trailing "titles, types, and field bindings" partly duplicates the output schema and the word "report" introduces scope ambiguity that costs a point.

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

Completeness3/5

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

With an output schema present and all three parameters fully described, the definition is minimally sufficient. It nonetheless leaves an agent guessing about read-only semantics, pagination behavior, and the mismatch between the stated report scope and the workspace/page parameters.

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 page, query, and workspace are already fully documented in the schema, and the baseline of 3 applies. The description adds no meaning beyond that, not even clarifying that these three filters combine or that all are optional.

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 gives a specific verb and resource ("List visuals") plus what each entry carries ("titles, types, and field bindings"), so an agent knows this is an enumerating read. It stops short of distinguishing itself from siblings like get_visual or update_visual_fields, and it scopes results to "the report" while the schema actually scopes by workspace/page.

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

Usage Guidelines2/5

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

There is no when-to-use guidance, no statement of when not to use it, and no pointer to get_visual for single-visual detail or to update_visual_fields for mutation. An agent must infer from the name alone that this is the enumeration entry point.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.