Skip to main content
Glama
Sign In
OpenProject CE MCP

OpenProject CE MCP

by jtauschl
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Local

get_document

Read-onlyIdempotent

Retrieve a single OpenProject document by ID, returning its full description by default or truncating it to a specified character limit.

Instructions

Get a single document by id.

The description is returned in full by default (single documents 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

NameRequiredDescriptionDefault
text_limitNo
document_idYes

Output Schema

NameRequiredDescriptionDefault
idYes
titleYes
projectYes
can_updateYes
created_atYes
project_idYes
descriptionYes
attachment_countYes
description_lengthNo
description_truncatedNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.4.4
  2. Removedv0.4.0
  3. Changed4 schema fields changedv0.3.7
    • addedInput schema / additionalProperties
      Added value: +false
    • removedOutput schema / properties / attachments_url
      Removed value: -{
-  "anyOf": [
-    {
-      "type": "string"
-    },
-    {
-      "type": "null"
-    }
-  ],
-  "title": "Attachments Url"
-}
    • removedOutput schema / properties / url
      Removed value: -{
-  "title": "Url",
-  "type": "string"
-}
    • changedOutput schema / required
      Previous value: -[
-  "id",
-  "title",
-  "project_id",
-  "project",
-  "description",
-  "created_at",
-  "attachment_count",
-  "attachments_url",
-  "can_update",
-  "url"
-]New value: +[
+  "id",
+  "title",
+  "project_id",
+  "project",
+  "description",
+  "created_at",
+  "attachment_count",
+  "can_update"
+]
  4. Addedv0.3.3
  5. Removedv0.3.0
  6. First observedv0.2.2

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already establish read-only, idempotent, non-destructive behavior. The description adds useful behavioral detail: documents are returned in full by default, text_limit can truncate them, and truncation is signaled by description_truncated and description_length.

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 front-loaded with the core action and then explains the only non-obvious option. The sentences are compact and each carries relevant information without padding.

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?

For a simple read tool with rich annotations and an output schema, the description is largely complete, especially around truncation behavior. The remaining gap is that it does not clarify document_id provenance or differentiate this tool from sibling retrieval tools.

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

Parameters3/5

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

Schema description coverage is 0%, so the description must compensate. It explains text_limit and its side effects well, but document_id is only implicitly defined as the id used to retrieve the document, with no format or source details.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/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 a single document by id." It is clear what the tool retrieves, but it does not distinguish itself from nearby retrieval tools such as list_documents or get_wiki_page.

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

Usage Guidelines3/5

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

The by-id retrieval scenario is implied clearly, but the description does not explicitly say when to use this instead of list_documents or other get_* siblings. No prerequisites or exclusions are stated.

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