Skip to main content
Glama

ui_get_state

Fetches a complete UI snapshot of all projects and the active project, optionally including archived projects, for app state inspection and rendering.

Instructions

App-only: fetch full UI snapshot for projects and active project.

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

Input Schema

NameRequiredDescriptionDefault
project_idNo
include_archivedNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.6/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full behavioral burden. It implies a read-style fetch and notes the app-only restriction, but it does not disclose permissions, side effects, snapshot size, freshness, or what the returned state contains.

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?

The definition is a single front-loaded sentence with no redundant wording. It is concise, though its brevity contributes to the gaps in guidance and parameter meaning rather than being purely efficient.

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

Completeness2/5

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

With no annotations, no output schema, and two completely undocumented parameters, the description is too thin for an agent to invoke the tool confidently. It should at least clarify parameter effects and what the snapshot includes.

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

Parameters1/5

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

The schema has zero description coverage for both parameters, and the description does not explain what project_id controls or what include_archived changes. The phrase 'for projects and active project' hints at scope but does not map meaning to either parameter.

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 states a specific verb and resource: fetching a full UI snapshot covering projects and the active project. It is reasonably distinguishable from siblings like project_get or ui_select_project, though the 'App-only' prefix is slightly opaque and the exact scope of 'snapshot' remains vague.

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?

The only usage guidance is the 'App-only' constraint. There is no explicit when-to-use guidance, no comparison to alternatives such as project_get, and no explanation of when this snapshot is preferable to fetching project data through other tools.

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