Skip to main content
Glama
rillsoft

Rillsoft Project MCP server

Official

Download RIS document

rillsoft_document_ris_get
Read-onlyIdempotent

Download a document from the open Rillsoft project's document management to a specified local path. Existing files are refused unless overwrite is true; failures leave no partial file.

Instructions

Downloads one document of the open project from the document management of the Rillsoft Integration Server into a local file - the 'Download' button of the documents page, with the target path given instead of asked. An existing file at path is refused unless overwrite:true; on any failure no partial file is left behind. The document itself is not changed; rillsoft_document_ris_list names the ids. Runs with the login of the desktop session. No undo step.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYesabsolute path of the file to write, including the file name; the file is written, not opened
overwriteNotrue = replace a file that already exists at path
documentIdYesid of the document, from rillsoft_document_ris_list

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYesfile name of the document
pathYespath of the file that was written
uuidYesUUID of the element the document hangs on - a task, a subproject or the project itself
fileSizeYessize of the stored file in bytes
folderIdYesid of the DMS folder the document lies in
createdAtYestime the document was stored, DD.MM.YYYY hh:mm; empty when the server reports none
projectIdYesid of the project the document belongs to
documentIdYesid of the document on the server; what _get, _update and _delete take
folderPathYesnames of the DMS folders from the root, joined by ' / '; empty when the folder is unknown to the tree
descriptionYesdescription; empty when none is set
elementNameYesname of that element
bytesWrittenYesbytes written to that file
createdUserNameYesuser who stored it; empty when the server reports none

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv10.0.626

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive. Description adds valuable beyond-annotation behavior: an existing file is refused unless overwrite:true, no partial file is left on failure, runs with desktop session login. Does not mention output schema contents, but those are declared.

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?

Dense but front-loaded: purpose first, then overwrite rule, failure safety, and session context. Each sentence carries distinct information. Slightly long sentence but no filler.

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

Completeness5/5

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

Covers purpose, id source, overwrite semantics, failure safety, session authentication, and 'no undo' irreversibility. With a rich schema (100% coverage) and output schema, the description provides everything an agent needs to call it correctly.

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 100%, so parameters (path, overwrite, documentId) are fully documented in the schema. The description adds semantic context for path ('target path given instead of asked') and overwrite refusal behavior, but mostly reiterates schema content. Baseline 3 is appropriate.

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?

States a specific verb+resource ('Downloads one document of the open project from the document management') and maps it to a concrete UI analogue ('the Download button of the documents page'). Clearly distinguishes from siblings by contrasting the target path being given instead of asked, and points to rillsoft_document_ris_list for 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 clear usage context: which document source, where ids come from (rillsoft_document_ris_list), and the overwrite behavior condition. Does not explicitly name when to prefer rillsoft_document_ris_update/create, but the download purpose is unambiguous against those siblings.

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