Skip to main content
Glama

update_state

Update an existing state in a Plane project by specifying its ID. Adjust attributes such as name, color, group, sequence, or default status to reflect workflow changes.

Instructions

Update a state by ID.

Args: project_id: UUID of the project state_id: UUID of the state name: State name color: State color (hex color code) description: State description sequence: State sequence order group: State group (e.g., backlog, unstarted, started, completed, cancelled) is_triage: Whether this is a triage state default: Whether this is the default state external_source: External system source name external_id: External system identifier

Returns: Updated State object

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNo
colorNo
groupNo
defaultNo
sequenceNo
state_idYes
is_triageNo
project_idYes
descriptionNo
external_idNo
external_sourceNo

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
Behavior2/5

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

With no annotations, the description carries the full burden of behavioral disclosure. It only lists parameters and says 'Updated State object' is returned. It fails to explain critical update semantics such as whether this is a partial update (only provided fields changed) or a full replacement, permission requirements, or side effects.

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 description is concise and well-structured: a one-sentence summary followed by a clean Args list. Each parameter gets a short, relevant description without unnecessary fluff. It is appropriately sized for the number of parameters.

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?

Even though an output schema exists, the description lacks essential context for an update tool. It does not state whether updating is partial in nature, whether certain fields are mutually exclusive, or how errors are handled. The parameter list is helpful, but the behavioral context remains incomplete.

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 description compensates for the schema's 0% description coverage by providing a brief explanation for each of the 11 parameters. It clarifies that color is a hex code, gives examples for group, and explains external_source and external_id. This adds meaningful context beyond the raw schema types.

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 ('Update a state by ID') and identifies the resource (a state) with required identifiers. It distinguishes itself from sibling tools like create_state, delete_state, and retrieve_state by focusing on the update operation.

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?

No explicit guidance is given about when to use this tool versus alternatives. It does not mention that this is for modifying an existing state, nor does it contrast with create_state or other related tools. The only implied usage is derived from the name and the required IDs.

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/leigangzhang/plane-mcp-server-adapter'

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