Skip to main content
Glama
openapi-mcp-sdk

openapi-mcp-sdk

Get Docuengine Services

get_docuengine_services

Lists all available DocuEngine services and their required parameters, helping you identify which service to call and what inputs it needs.

Instructions

Returns the list of all available DocuEngine services with their required parameters.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "get_docuengine_services"
  }
}

Input Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.7/5.0
Behavior3/5

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

No annotations are supplied, so the description carries the full burden. The word 'Returns' implies a read-only, side-effect-free operation and the description discloses the shape of the result (service list plus required parameters), but it says nothing about authentication needs, whether the list is static, or the volume of data returned. For a zero-parameter listing tool this is reasonable but not rich.

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?

One sentence, front-loaded with the outcome, with no filler or redundancy. Every clause ('all available services', 'with their required parameters') adds distinct information.

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?

The tool is simple (no parameters, no output schema, no nested objects), and the description covers the essential point an agent needs: what comes back and that it includes the parameter requirements for each service. The absence of any note on response size or ordering is a minor gap only.

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

Parameters4/5

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

The tool takes zero parameters, which is the baseline-4 case: there are no arguments whose meaning the description would need to clarify. The schema is also empty and consistent with the description, so nothing is misrepresented.

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 and resource ('Returns the list of all available DocuEngine services') plus the payload characteristic ('with their required parameters'), so the agent knows exactly what it gets back. It does not explicitly contrast itself with get_docuengine_documents or get_docuengine_request_status, so it stops short of full sibling differentiation.

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?

Usage is only implied: the phrase 'with their required parameters' hints that this is a discovery/metadata call to run before invoking a service, but there is no explicit when-to-use statement, no note on caching or ordering, and no named alternative. Adequate but leaves the agent to infer the workflow position.

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