Skip to main content
Glama

create_work_item_relation_definition

Define named relationship types between work items with outward and inward labels to describe connections.

Instructions

Create a new workspace relation definition.

A relation definition describes a named relationship type with an outward label (how the source item describes the target) and an inward label (how the target item describes the source).

Args: name: Unique name for this relation definition. outward: Label describing the relation from the source item's perspective. inward: Label describing the relation from the target item's perspective. is_active: Whether this definition is active and available for use. color: Hex color code for UI display.

Returns: Created WorkItemRelationDefinition object.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYes
colorNo
inwardNo
outwardNo
is_activeNo

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, so the mutation behavior is clear. The description adds that this is a create operation, which is consistent. It does not elaborate on potential side effects, such as whether definitions can be modified or deleted later, or any restrictions on uniqueness. The description adds minimal context beyond the 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 concise and well-structured: a one-line summary, a brief explanation of the resource, an 'Args' list with clear labels, and a 'Returns' line. Every sentence is informative and there is no redundancy or fluff.

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 moderate complexity (5 parameters, output schema exists), the description adequately covers the purpose, parameters, and return type. It could mention uniqueness constraints for the 'name' parameter, but overall it is sufficient for the agent to understand and invoke the tool correctly.

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?

With 0% schema description coverage, the description compensates well by listing all parameters in the 'Args' section and explaining each: name (unique name), outward/inward (labels from source/target perspective), is_active (availability for use), color (hex code for UI). This adds meaning beyond the property names and types in the schema. However, it does not specify format constraints (e.g., max length for name).

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 verb 'Create' and the resource 'workspace relation definition'. It explains that a relation definition describes a named relationship type, distinguishing it from creating an actual relation instance (a sibling tool). The purpose is unambiguous.

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 implies when to use the tool (to create a relation definition) but does not explicitly state when not to use it or provide alternatives. It lacks guidance on prerequisites or context, relying on the tool name and sibling context. The agent would need to infer usage from the description of what a relation definition is.

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