Skip to main content
Glama

list_documents

Read-only

Retrieve documents in a Polarion project, returning key details like ID, name, type, status, author, and last editor for quick document overview.

Instructions

List a project's documents.

Returns space_id + document_name (inputs to the other document tools) plus type, status, updated timestamp, and display names of creator (author) and last editor (last_updated_by). 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?

Beyond the readOnlyHint annotation, the description adds that results are cached for 60 seconds and returns specific fields like creator and last editor, which helps the agent understand the tool's behavior and output characteristics.

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 two sentences, front-loaded with the purpose, and each sentence adds value: first states action, second details output and caching. No unnecessary words.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The description covers purpose and output fields, but given there are three parameters and output schema exists, the lack of parameter details leaves the agent underinformed about pagination. With pagination parameters, a more complete description would include usage hints.

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

Parameters1/5

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

The description does not mention any of the three parameters (page_size, project_id, page_number) despite schema coverage being only 33% (only project_id has a description). The agent receives no guidance on pagination or required inputs.

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 'List a project's documents' and details the returned fields including document identifiers that serve as inputs to other tools, effectively distinguishing it from sibling tools like get_document or create_document.

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 description does not explicitly state when to use or avoid this tool versus alternatives, though mentioning it returns 'inputs to the other document tools' implies a discovery use case. No direct exclusions or comparisons are provided.

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