Skip to main content
Glama

list_documents

Read-only

List all documents in a Polarion project. Returns document name, type, status, and metadata for use with other document tools.

Instructions

List a project's documents.

Returns space_id + document_name — the inputs to every other document tool — plus type, status, updated, and creator/editor display names. Use get_document for author/editor ids. Discovery scan cached 60s.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
page_sizeNo
project_idYesPolarion project ID.
page_numberNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageYes
itemsYes
has_moreNo
page_sizeYes
total_countYes
Behavior4/5

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

Description adds caching behavior (60s) beyond readOnlyHint annotation. Also lists returned fields, providing transparency on output. No contradiction with annotations.

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?

Two concise sentences with front-loaded purpose. No redundancy; every sentence adds value.

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 output schema exists to document return values, description completes the picture with caching and tool differentiation. Missing parameter details slightly reduce completeness.

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

Parameters2/5

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

Schema coverage is only 33% (project_id described). Description implies project_id needed but does not explain page_size or page_number. With low coverage, description should compensate, but it falls short.

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?

Clear verb-resource pair: 'List a project's documents.' Specifies returned fields (space_id, document_name, etc.) and explicitly distinguishes sibling tool get_document by stating when to use it for author/editor ids.

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?

Provides guidance to use get_document for more detail, implying this tool is for summary listing. Also mentions 60-second cache, but lacks explicit when-not-to-use or alternatives beyond get_document.

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/devemberx/mcp-server-polarion'

If you have feedback or need assistance with the MCP directory API, please join our Discord server