Skip to main content
Glama

update_work_item_relation_definition

Idempotent

Update an existing work item relation definition: modify its name, outward/inward labels, active status, or color.

Instructions

Update an existing workspace relation definition.

Args: definition_id: UUID of the relation definition to update. name: New name for this definition. outward: Updated outward label. inward: Updated inward label. is_active: Updated active status. color: Updated hex color code.

Returns: Updated WorkItemRelationDefinition object.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNo
colorNo
inwardNo
outwardNo
is_activeNo
definition_idYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
idNo
nameNo
colorNo
inwardNo
outwardNo
is_activeNo
workspaceNo
created_atNo
is_defaultNo
sort_orderNo
updated_atNo
Behavior3/5

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

Annotations already indicate readOnlyHint=false and destructiveHint=false. The description adds no behavioral details beyond stating 'Update,' so it does not surpass what annotations convey.

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 concise: one sentence for purpose, bullet-like parameter list, and return statement. No redundancy or unnecessary text.

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 and annotations, the description is adequate. It covers purpose, parameters, and return type. Minor improvement would be noting partial updates via optional parameters.

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?

While the schema has 0% description coverage, the description lists all 6 parameters with brief explanations (e.g., 'UUID of the relation definition to update'), adding meaning beyond type information. It lacks detailed constraints or examples.

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 'Update an existing workspace relation definition,' specifying a precise verb and resource. It distinguishes from sibling tools like create_work_item_relation_definition and delete_work_item_relation_definition.

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?

Usage is implied by the verb 'Update' and the tool name, but no explicit guidance is given on when to use versus alternatives, nor are any prerequisites or exclusions mentioned.

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