Skip to main content
Glama
openapi-mcp-sdk

openapi-mcp-sdk

Get Docuengine Documents

get_docuengine_documents

Retrieve download links for documents produced by a request using the request_id to access the generated files.

Instructions

Returns the download links for the documents produced by a request.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "request_id": "<request_id>"
    },
    "name": "get_docuengine_documents"
  }
}

Input Schema

NameRequiredDescriptionDefault
request_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.8/5.0
Behavior2/5

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

With no annotations, the description carries the full behavioral burden. It discloses that the output is download links, but says nothing about whether links expire, whether the call requires the request to be finished, whether it errors on a pending request, or what auth/permissions apply.

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?

A single efficient sentence that front-loads the returned resource. It is not padded, though brevity here borders on under-specification rather than economy.

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?

For a one-parameter retrieval tool with no output schema, the description does cover the essential return value (download links). It falls short on prerequisites, link lifetime, and parameter provenance, which an agent needs to invoke it correctly.

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?

The single parameter has 0% schema description coverage, so the description must compensate and largely does not. It only implies request_id refers to a prior Docuengine request, without indicating where the id comes from, its format, or how a caller obtains it.

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?

States a specific verb ('Returns') and resource ('download links for the documents produced by a request'), which is much clearer than the name alone. It is distinguishable from get_docuengine_request_status, but the description never explicitly contrasts the two, so sibling differentiation is only implicit.

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?

There is no explicit when-to-use guidance: nothing says the request must be completed, that status should be checked first via get_docuengine_request_status, or what happens if documents are not yet ready. The usage is only faintly implied by 'produced by a request'.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.