Skip to main content
Glama
MCP Dokploy Online
by igoruam

settings-getOpenApiDocument

Read-onlyIdempotent

Retrieves the Dokploy OpenAPI document from settings so you can inspect available endpoints and integrate or automate infrastructure management.

Instructions

GET /settings.getOpenApiDocument

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": "settings-getOpenApiDocument"
  }
}

Input Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

C2.1/5.0
Behavior2/5

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

Annotations already declare readOnlyHint=true, openWorldHint=true, and idempotentHint=true, so the safety profile is covered without the description. The description adds nothing beyond that: no indication of document size, whether it reflects live configuration, or whether auth scope matters.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness2/5

Is the description appropriately sized, front-loaded, and free of redundancy?

It is short with no wasted words, but that brevity comes from under-specification rather than efficiency. A bare route string is not a useful structure for an agent deciding when or how to call the tool.

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 zero-parameter read tool the annotations suffice for safety, but with no output schema the description must explain what is returned, and it says nothing about the document's contents or shape. The definition is technically callable but leaves the agent guessing about the result.

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, so there is nothing for the description to compensate for and the baseline of 4 applies. The input schema is empty and fully consistent with the route-style description.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose2/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description is just the HTTP route 'GET /settings.getOpenApiDocument', which restates the tool name in route form rather than explaining what the tool does. An agent can infer it fetches an OpenAPI document for settings endpoints, but nothing states what the document covers, its format, or how it differs from the many sibling settings-get* tools.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines1/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no when-to-use guidance, no preconditions, and no mention of alternatives among the numerous sibling tools. The agent gets zero help deciding whether to call this versus settings-getWebServerSettings or settings-getTraefikPorts.

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