Skip to main content
Glama
openapi-mcp-sdk

openapi-mcp-sdk

Get Docuengine Request Status

get_docuengine_request_status

Retrieve the details and current status of a specific DocuEngine request using its request ID.

Instructions

Returns the details and status of a specific DocuEngine 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_request_status"
  }
}

Input Schema

NameRequiredDescriptionDefault
request_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.7/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full behavioral burden. 'Returns' signals a read operation, but the description does not disclose response shape, error behavior for invalid IDs, permission requirements, or how the status relates to async processing.

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?

The description is a single front-loaded sentence with no wasted wording. It is appropriately concise, though its brevity contributes to gaps covered by other dimensions.

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

Completeness2/5

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

For a simple lookup tool, the description is still under-specified because there is no output schema and no annotations. An agent does not learn what 'details' are returned, what happens for invalid IDs, or where the request_id originates.

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 description coverage is 0%, so the description must compensate for the undocumented request_id parameter. It only says the ID identifies a 'specific DocuEngine request' and gives no format, origin, or example beyond the parameter name.

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: it returns the details and status of a specific DocuEngine request. It is clear what the tool does, but it does not differentiate from the sibling check_async_status or explain whether that status tool is an alternative.

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, no when-not-to-use guidance, and no named alternatives such as check_async_status. The intended use is only implied by the phrase 'specific DocuEngine request.'

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