Skip to main content
Glama

retrieve_work_item_by_identifier

Read-only

Fetch a specific work item using its full identifier (e.g., PROJ-123). Supports optional expansion of related fields like assignees, labels, and state.

Instructions

Retrieve a work item by its full identifier (project prefix + sequence number).

The identifier must be in PROJECT-N format where PROJECT is the project's identifier string and N is the sequence number. Both parts are required.

Valid sparse fields values include: id, name, sequence_id, priority, state, project, workspace, parent, assignees, labels, type_id, start_date, target_date, created_at, updated_at, created_by, updated_by, is_draft, external_source, external_id, estimate_point. Use project (not project_id) to get the project UUID.

If you need the project UUID from a short identifier like "SHO", use list_projects() instead - it returns id and identifier for every project.

Args: work_item_identifier: Full work item identifier in PROJECT-N format expand: Comma-separated fields to expand (e.g., "assignees,labels,state") fields: Comma-separated sparse fieldset (see valid values above) external_id: External system identifier for filtering external_source: External system source name for filtering order_by: Field to order results by

Returns: WorkItemDetail object with expanded relationships

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
expandNo
fieldsNo
order_byNo
external_idNo
external_sourceNo
work_item_identifierYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
idNo
nameNo
typeNo
pointNo
stateNo
labelsNo
parentNo
projectNo
type_idNo
is_draftNo
priorityNo
assigneesNo
workspaceNo
created_atNo
created_byNo
deleted_atNo
sort_orderNo
start_dateNo
updated_atNo
updated_byNo
archived_atNo
external_idNo
sequence_idNo
target_dateNo
completed_atNo
estimate_pointNo
external_sourceNo
description_htmlNo
description_binaryNo
description_strippedNo
Behavior4/5

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

Annotations already indicate read-only and open-world behavior. The description adds context by listing valid `fields` values, explaining the `expand` parameter, and noting that the return type is a WorkItemDetail object with expanded relationships. 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.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-structured: a concise summary followed by formatting notes, then a bulleted list of valid field values, then parameter descriptions, and finally return type. While a bit lengthy, the organization makes it easy to scan.

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 (not shown but signaled), the description adequately covers the return type. All six parameters are described, including the required one. The description is complete enough for an AI agent to use 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?

Although the input schema has zero description coverage (0%), the description compensates well by explaining the format for `work_item_identifier`, enumerating valid `fields` values, and briefly describing the other parameters. Some parameters like `external_id` and `external_source` receive only basic descriptions, but overall adds substantial meaning.

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 specifies retrieving a work item by its full identifier in PROJECT-N format. It clearly differentiates from the sibling tool `retrieve_work_item` by emphasizing the identifier format and providing an alternative for extracting project UUIDs.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description explicitly states when to use this tool and when not to: it explains that for obtaining a project UUID from a short identifier, `list_projects()` should be used instead. It also details the required format and valid field values.

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