Skip to main content
Glama

get_work_package

Retrieve a work package by ID and view its full description. Optionally truncate the description to a specific character limit for easier reading.

Instructions

Get a work package by id, including its full description.

work_package_id: internal id (e.g., 952) or display_id (e.g., "PROJ-51"), not UI display number (e.g., 51).

The description is returned in full by default (single work packages are not truncated). Pass text_limit to cap it at that many characters; when the text is cut, description_truncated is true and description_length reports the real length.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
text_limitNo
work_package_idYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYes
urlYes
typeYes
authorNo
sprintYes
statusYes
projectYes
subjectYes
versionYes
assigneeYes
categoryNo
childrenNo
due_dateYes
durationNo
priorityYes
readonlyNo
ancestorsNo
parent_idYes
created_atNo
display_idYes
spent_timeNo
start_dateYes
updated_atNo
descriptionYes
responsibleYes
lock_versionYes
project_phaseYes
relations_urlYes
activities_urlYes
estimated_timeNo
remaining_timeNo
percentage_doneNo
derived_due_dateNo
parent_display_idYes
schedule_manuallyNo
children_truncatedNo
derived_start_dateNo
description_lengthNo
ancestors_truncatedNo
percentage_completeYes
description_truncatedNo
derived_estimated_timeNo
derived_remaining_timeNo
derived_percentage_doneNo
ignore_non_working_daysNo
Behavior5/5

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

With no annotations, the description carries the full burden and does so excellently. It discloses that single work packages are not truncated by default, explains the `text_limit` truncation behavior, and mentions the `description_truncated` and `description_length` flags. This goes beyond a basic read operation.

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 well structured with clear paragraphs and no wasted words. Each sentence provides necessary information, from the core purpose to ID semantics to truncation behavior. It remains concise despite covering multiple important details.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given that an output schema exists, the description does not need to explain return values. It covers the essential behavioral aspects (ID formats, truncation) and is fully adequate for a single-resource getter tool. The description is complete and self-sufficient.

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

Parameters5/5

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

Schema description coverage is 0%, but the description fully compensates. It explains `work_package_id` semantics with concrete examples (952 vs 'PROJ-51' vs 51) and details the effect of `text_limit` including the flags set when truncation occurs. This adds immense value over the bare schema.

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 tool's function: 'Get a work package by id, including its full description.' It uses a specific verb (get) and resource (work package) and distinguishes it from sibling list/search tools by emphasizing retrieval by a single ID.

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

Usage Guidelines4/5

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

The usage context is clear: use when you have a work package ID. It also provides important guidance on ID formats (internal vs display_id vs UI number), which is a key prerequisite. However, it does not explicitly mention alternatives or when not to use this tool, so it falls just short of a 5.

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/jtauschl/openproject-ce-mcp'

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