Skip to main content
Glama

get_work_package_activities

Read-onlyIdempotent

Retrieve a work package's activity log, newest first, to review comments and change history; optionally cap comment text length and select returned fields.

Instructions

Get the activity log for a work package, most recent first.

Comments are returned in full by default (this is one work package's own history, not an open-ended multi-row list; same rationale as get_work_package). Pass text_limit to cap each comment at that many characters; when a comment is cut, comment_truncated is true and comment_length reports its real length.

When OPENPROJECT_READ_PROJECTS is not *, or a work package or custom field is hidden, change details are left out and details_omitted is true: OpenProject returns them as text in the API user's language with no structure to check against the read scope or the hidden fields, and the text can name parents, projects and versions of projects outside it and carry the values of hidden fields. Comments, user and time are unaffected.

Input Schema

NameRequiredDescriptionDefault
limitNoNumber of most recent activities, capped at OPENPROJECT_MAX_PAGE_SIZE. Not paged.
selectNoFields to return; a requested unset field comes back as null. Allowed: comment, comment_length, comment_truncated, created_at, details, details_omitted, details_truncated, id, type, user, version.
text_limitNo
work_package_idYesWork package id (e.g. 952) or display id (e.g. "PROJ-51"), not the bare number 51.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.4.4
  2. Removedv0.4.0
  3. Changed1 schema field changedv0.3.7
    • addedInput schema / additionalProperties
      Added value: +false
  4. Addedv0.3.3
  5. Removedv0.3.0
  6. Changed2 schema fields changedv0.2.3
    • addedInput schema / properties / text_limit
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "integer"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Text Limit"
      +}
    • changedOutput schema / (root)
      Previous value: -{
      -  "$defs": {
      -    "ActivitySummary": {
      -      "properties": {
      -        "comment": {
      -          "anyOf": [
      -            {
      -              "type": "string"
      -            },
      -            {
      -              "type": "null"
      -            }
      -          ],
      -          "title": "Comment"
      -        },
      -        "created_at": {
      -          "anyOf": [
      -            {
      -              "type": "string"
      -            },
      -            {
      -              "type": "null"
      -            }
      -          ],
      -          "title": "Created At"
      -        },
      -        "id": {
      -          "title": "Id",
      -          "type": "integer"
      -        },
      -        "type": {
      -          "anyOf": [
      -            {
      -              "type": "string"
      -            },
      -            {
      -              "type": "null"
      -            }
      -          ],
      -          "title": "Type"
      -        },
      -        "user": {
      -          "anyOf": [
      -            {
      -              "type": "string"
      -            },
      -            {
      -              "type": "null"
      -            }
      -          ],
      -          "title": "User"
      -        },
      -        "version": {
      -          "anyOf": [
      -            {
      -              "type": "integer"
      -            },
      -            {
      -              "type": "null"
      -            }
      -          ],
      -          "title": "Version"
      -        }
      -      },
      -      "required": [
      -        "id",
      -        "type",
      -        "version",
      -        "user",
      -        "comment",
      -        "created_at"
      -      ],
      -      "title": "ActivitySummary",
      -      "type": "object"
      -    }
      -  },
      -  "properties": {
      -    "count": {
      -      "title": "Count",
      -      "type": "integer"
      -    },
      -    "results": {
      -      "items": {
      -        "$ref": "#/$defs/ActivitySummary"
      -      },
      -      "title": "Results",
      -      "type": "array"
      -    }
      -  },
      -  "required": [
      -    "count",
      -    "results"
      -  ],
      -  "title": "ActivityListResult",
      -  "type": "object"
      -}New value: +null
  7. First observedv0.2.2

TDQS

A4.5/5.0
Behavior5/5

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

Beyond the readOnly/idempotent annotations, the description discloses truncation behavior: comments are full by default, text_limit caps them, and comment_truncated/comment_length signal cuts. It also explains privacy-driven omission of change details when OPENPROJECT_READ_PROJECTS is restricted or fields are hidden, including which fields are unaffected. This is substantial behavioral context.

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 front-loaded with the core operation and then explains truncation and privacy exceptions. It is appropriately sized for a tool with non-obvious privacy behavior, though the reference to 'same rationale as get_work_package' is slightly indirect.

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?

With no output schema, the description does a good job explaining the key return behaviors around comments, truncation, and details_omitted. It does not fully enumerate every possible return field, but the schema's select parameter lists them and the description covers the non-obvious cases.

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?

Schema coverage is 75%, and the description adds meaningful semantics for text_limit, which has no schema description, including its truncation flags. Other parameters like limit, select, and work_package_id are already documented in the schema, so the description appropriately complements rather than repeats them.

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 states a specific verb and resource: 'Get the activity log for a work package,' with the ordering 'most recent first.' It also distinguishes this from an open-ended multi-row list, making the scope clear against siblings like list_work_package_reactions or get_work_package.

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 clarifies that this is one work package's own history, not a general listing, and explains the text_limit use case. It does not explicitly name alternative tools or state when not to use it, but the contextual distinction is clear enough for routing.

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

Deploy Server

Other Tools