Skip to main content
Glama

get_work_package

Retrieve a work package by its internal or display ID, including the full description. Optionally limit the description length with a text limit parameter.

Instructions

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

work_package_id: internal id (e.g., 952) or display_id (e.g., "OPM-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
statusYes
projectYes
subjectYes
versionYes
assigneeYes
categoryNo
childrenNo
due_dateYes
durationNo
priorityYes
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
parent_display_idYes
children_truncatedNo
description_lengthNo
ancestors_truncatedNo
percentage_completeYes
description_truncatedNo
derived_estimated_timeNo
derived_remaining_timeNo
Behavior5/5

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

With no annotations provided, the description fully bears the burden of transparency. It explicitly states that the description is returned in full by default, explains the effect of the text_limit parameter (truncation, flag, and length), and clarifies the allowable ID formats. No behavioral aspects are hidden.

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 (two short paragraphs) and front-loaded: the first sentence states the core purpose, followed by parameter details. Every sentence adds essential information; there is no redundancy or fluff.

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 the presence of an output schema (not shown but indicated), the description need not detail return values. It covers the critical aspects: parameter formats, default behavior, and text_limit effects. For a single-item retrieval tool, this is complete and sufficient for correct invocation.

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?

The input schema has 0% description coverage, so the description must compensate. It does so thoroughly: for work_package_id, it clarifies the two acceptable formats (internal ID and display ID) and warns against using the UI display number. For text_limit, it explains its purpose and consequences (truncation flag and length), adding significant value beyond the schema structure.

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 'Get a work package by id, including its full description,' which is a specific verb-resource pair. It distinguishes from sibling tools like 'get_work_packages' (plural) and 'list_work_packages' by focusing on a single work package with full description.

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 description explains when to use this tool (to get a single work package with full description) and provides crucial guidance on the work_package_id parameter (internal or display ID format). Although it does not explicitly state when not to use it, the context is clear enough for an AI agent to differentiate from similar tools.

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