Skip to main content
Glama

retrieve_state

Read-only

Retrieve a state by its ID within a project. Provide the project ID and state ID to get the state object.

Instructions

Retrieve a state by ID.

Args: project_id: UUID of the project state_id: UUID of the state

Returns: State object

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
state_idYes
project_idYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
idNo
nameYes
colorYes
groupNo
defaultNo
projectNo
sequenceNo
is_triageNo
workspaceNo
created_atNo
created_byNo
deleted_atNo
updated_atNo
updated_byNo
descriptionNo
external_idNo
external_sourceNo
Behavior3/5

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

The description states that it returns a 'State object', but the exact structure is likely defined in the output schema. The annotations already indicate readOnlyHint and openWorldHint, so the description adds minimal behavioral context. No contradictions with annotations.

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?

The description is remarkably concise, consisting of a single line of purpose and a brief parameter list. Every element is necessary and front-loaded; there is no superfluous content.

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?

Given the presence of an output schema, the description appropriately does not elaborate on return values. It sufficiently covers the two required parameters. For a simple retrieval tool with low parameter count, the description is complete enough, though it could mention that the state must exist or handle errors.

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

Parameters4/5

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

The input schema has 0% description coverage, but the description explicitly adds semantics by noting that 'project_id' is a 'UUID of the project' and 'state_id' is a 'UUID of the state', providing essential context beyond the schema's type definitions.

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 clearly states the action ('Retrieve'), the resource ('state'), and the identifying parameters ('by ID'). It distinguishes from siblings like 'list_states' and 'create_state' by specifying retrieval of a single state via IDs.

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?

The description does not provide explicit guidance on when to use this tool versus alternatives. It implies usage for fetching a specific state, but lacks comparison with 'list_states' or 'retrieve_state_by_identifier' (not present, but siblings include other retrieve tools). This is adequate but not exemplary.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/Bl4nk44/plane-ce-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server