Skip to main content
Glama
jtauschl

OpenProject MCP

by jtauschl
OverviewSchemaRelated ServersScoreDiscussions
Python
Local

list_documents

Retrieve project documents, optionally filtered by project, with pagination support for large result sets.

Instructions

List documents, optionally filtered to a single project.

limit is capped at OPENPROJECT_MAX_PAGE_SIZE (default 50); pass the returned next_offset as the next call's offset to page past the cap. total is only the count of allowed documents returned on THIS page, not a full count of all matches — the search stops as soon as it has enough, so an exact total would need an extra full walk. Page until next_offset is null.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNo
offsetNo
projectNo

Schema Changelog

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

  1. Changed1 schema field changedv0.3.7
    • addedInput schema / additionalProperties
      Added value: +false
  2. Addedv0.3.3
  3. Removedv0.3.0
  4. Changed1 schema field changedv0.2.3
    • changedOutput schema / (root)
      Previous value: -{
-  "$defs": {
-    "DocumentSummary": {
-      "properties": {
-        "attachment_count": {
-          "title": "Attachment Count",
-          "type": "integer"
-        },
-        "can_update": {
-          "title": "Can Update",
-          "type": "boolean"
-        },
-        "created_at": {
-          "anyOf": [
-            {
-              "type": "string"
-            },
-            {
-              "type": "null"
-            }
-          ],
-          "title": "Created At"
-        },
-        "description": {
-          "anyOf": [
-            {
-              "type": "string"
-            },
-            {
-              "type": "null"
-            }
-          ],
-          "title": "Description"
-        },
-        "id": {
-          "title": "Id",
-          "type": "integer"
-        },
-        "project": {
-          "anyOf": [
-            {
-              "type": "string"
-            },
-            {
-              "type": "null"
-            }
-          ],
-          "title": "Project"
-        },
-        "project_id": {
-          "anyOf": [
-            {
-              "type": "integer"
-            },
-            {
-              "type": "null"
-            }
-          ],
-          "title": "Project Id"
-        },
-        "title": {
-          "title": "Title",
-          "type": "string"
-        },
-        "url": {
-          "title": "Url",
-          "type": "string"
-        }
-      },
-      "required": [
-        "id",
-        "title",
-        "project_id",
-        "project",
-        "description",
-        "created_at",
-        "attachment_count",
-        "can_update",
-        "url"
-      ],
-      "title": "DocumentSummary",
-      "type": "object"
-    }
-  },
-  "properties": {
-    "count": {
-      "title": "Count",
-      "type": "integer"
-    },
-    "limit": {
-      "title": "Limit",
-      "type": "integer"
-    },
-    "next_offset": {
-      "anyOf": [
-        {
-          "type": "integer"
-        },
-        {
-          "type": "null"
-        }
-      ],
-      "title": "Next Offset"
-    },
-    "offset": {
-      "title": "Offset",
-      "type": "integer"
-    },
-    "results": {
-      "items": {
-        "$ref": "#/$defs/DocumentSummary"
-      },
-      "title": "Results",
-      "type": "array"
-    },
-    "total": {
-      "title": "Total",
-      "type": "integer"
-    },
-    "truncated": {
-      "title": "Truncated",
-      "type": "boolean"
-    }
-  },
-  "required": [
-    "offset",
-    "limit",
-    "total",
-    "count",
-    "next_offset",
-    "truncated",
-    "results"
-  ],
-  "title": "DocumentListResult",
-  "type": "object"
-}New value: +null
  5. First observedv0.2.2

TDQS

A4.2/5.0
Behavior5/5

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

With no annotations provided, the description fully carries the transparency burden. It discloses critical behavioral traits: the limit cap (OPENPROJECT_MAX_PAGE_SIZE), pagination via next_offset, the meaning of 'total' as per-page count only, and early termination of search. This goes far beyond typical list tool descriptions and is essential for correct invocation.

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, using a short first sentence for purpose and a second paragraph for pagination details. Every sentence contributes value, with no redundancy. It is well-structured and front-loaded, making it easy for an agent to parse quickly.

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 no output schema, the description explains behavior thoroughly, including pagination and count limitations. It doesn't specify the return structure or error cases, but for a list tool with moderate complexity, this is sufficient. The provided details are complete enough for safe invocation.

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 0%, so the description must clarify parameters. It explains 'limit' is capped, 'offset' should be set from next_offset for pagination, and 'project' filters results. These insights add meaning to all three parameters, though it doesn't restate types or defaults (already in 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 first sentence explicitly states the action (list) and resource (documents) with an optional filter by project. This clearly distinguishes it from sibling tools like list_grids or list_categories, which target different resource types.

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

Usage Guidelines2/5

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

The description mentions 'optionally filtered to a single project' but does not provide guidance on when to use this tool versus alternatives (e.g., get_document for a single document). No exclusions or alternative recommendations are given, leaving the agent to infer usage context.

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