Skip to main content
Glama

get_work_package

Fetch a work package by its ID, including its full description. Get complete, untruncated task details directly from OpenProject.

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 same value list_work_packages/ search_work_packages return as each row's id field.

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
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
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

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. Changed5 schema fields changedv0.3.7
    • addedInput schema / additionalProperties
      Added value: +false
    • removedOutput schema / properties / activities_url
      Removed value: -{
      -  "anyOf": [
      -    {
      -      "type": "string"
      -    },
      -    {
      -      "type": "null"
      -    }
      -  ],
      -  "title": "Activities Url"
      -}
    • removedOutput schema / properties / relations_url
      Removed value: -{
      -  "anyOf": [
      -    {
      -      "type": "string"
      -    },
      -    {
      -      "type": "null"
      -    }
      -  ],
      -  "title": "Relations Url"
      -}
    • removedOutput schema / properties / url
      Removed value: -{
      -  "title": "Url",
      -  "type": "string"
      -}
    • changedOutput schema / required
      Previous value: -[
      -  "id",
      -  "display_id",
      -  "subject",
      -  "type",
      -  "status",
      -  "priority",
      -  "project_phase",
      -  "assignee",
      -  "responsible",
      -  "project",
      -  "version",
      -  "sprint",
      -  "parent_id",
      -  "parent_display_id",
      -  "start_date",
      -  "due_date",
      -  "percentage_complete",
      -  "lock_version",
      -  "description",
      -  "url",
      -  "activities_url",
      -  "relations_url"
      -]New value: +[
      +  "id",
      +  "display_id",
      +  "subject",
      +  "type",
      +  "status",
      +  "priority",
      +  "project_phase",
      +  "assignee",
      +  "responsible",
      +  "project",
      +  "version",
      +  "sprint",
      +  "parent_id",
      +  "parent_display_id",
      +  "start_date",
      +  "due_date",
      +  "percentage_complete",
      +  "lock_version",
      +  "description"
      +]
  2. Changed2 schema fields changedv0.3.5
    • changedOutput schema / properties / ancestors / anyOf
      Previous value: -[
      -  {
      -    "items": {
      -      "additionalProperties": {
      -        "type": "string"
      -      },
      -      "type": "object"
      -    },
      -    "type": "array"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "items": {
      +      "additionalProperties": {
      +        "anyOf": [
      +          {
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      },
      +      "type": "object"
      +    },
      +    "type": "array"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • changedOutput schema / properties / children / anyOf
      Previous value: -[
      -  {
      -    "items": {
      -      "additionalProperties": {
      -        "type": "string"
      -      },
      -      "type": "object"
      -    },
      -    "type": "array"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "items": {
      +      "additionalProperties": {
      +        "anyOf": [
      +          {
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      },
      +      "type": "object"
      +    },
      +    "type": "array"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
  3. Addedv0.3.3
  4. Removedv0.3.0
  5. Changed17 schema fields changedv0.2.3
    • addedInput schema / properties / text_limit
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "integer"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Text Limit"
      +}
    • addedOutput schema / properties / ancestors
      Added value: +{
      +  "anyOf": [
      +    {
      +      "items": {
      +        "additionalProperties": {
      +          "type": "string"
      +        },
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Ancestors"
      +}
    • addedOutput schema / properties / ancestors_truncated
      Added value: +{
      +  "default": false,
      +  "title": "Ancestors Truncated",
      +  "type": "boolean"
      +}
    • addedOutput schema / properties / author
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Author"
      +}
    • addedOutput schema / properties / category
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Category"
      +}
    • addedOutput schema / properties / children
      Added value: +{
      +  "anyOf": [
      +    {
      +      "items": {
      +        "additionalProperties": {
      +          "type": "string"
      +        },
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Children"
      +}
    • addedOutput schema / properties / children_truncated
      Added value: +{
      +  "default": false,
      +  "title": "Children Truncated",
      +  "type": "boolean"
      +}
    • addedOutput schema / properties / created_at
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Created At"
      +}
    • addedOutput schema / properties / derived_estimated_time
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Derived Estimated Time"
      +}
    • addedOutput schema / properties / derived_remaining_time
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Derived Remaining Time"
      +}
    • addedOutput schema / properties / description_length
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "integer"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Description Length"
      +}
    • addedOutput schema / properties / description_truncated
      Added value: +{
      +  "default": false,
      +  "title": "Description Truncated",
      +  "type": "boolean"
      +}
    • addedOutput schema / properties / duration
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Duration"
      +}
    • addedOutput schema / properties / estimated_time
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Estimated Time"
      +}
    • addedOutput schema / properties / remaining_time
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Remaining Time"
      +}
    • addedOutput schema / properties / spent_time
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Spent Time"
      +}
    • addedOutput schema / properties / updated_at
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Updated At"
      +}
  6. First observedv0.2.2

TDQS

A4.8/5.0
Behavior5/5

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

No annotations are provided, so the description carries the full burden. It discloses that the full description is returned by default, explains the text_limit parameter's effect, and describes the truncation-related fields (description_truncated, description_length). This is rich behavioral detail.

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 compact and front-loaded with the primary purpose. Each sentence adds necessary detail (id formats, truncation behavior) without redundancy or fluff. It is appropriately sized for the tool's complexity.

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?

The description covers everything an agent needs: id type ambiguity, default return behavior, and optional text_limit semantics. Since an output schema exists, return values need not be explained. The tool is well-specified 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?

Schema coverage is 0%, meaning the schema provides no descriptions. The description compensates fully by explaining both parameters: work_package_id (internal or display_id, not UI display number) and text_limit (capping behavior, truncation flags). This adds significant meaning beyond the raw 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 retrieves a single work package by id, with a direct verb ('Get') and resource ('work package'). It also distinguishes from siblings like list_work_packages and search_work_packages by emphasizing the singular nature and the id field.

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 provides clear context on when to use the tool (you have a specific work_package_id) and clarifies which id values are accepted, even referencing sibling tools for id format. It lacks an explicit 'use this instead of X' but the context is sufficient.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

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