Skip to main content
Glama
MCP Dokploy Online
by igoruam

customRole-all

Read-onlyIdempotent

Lists all custom roles defined in your Dokploy instance, so you can review available role definitions and permissions before assigning them to users.

Instructions

GET /customRole.all

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": "customRole-all"
  }
}

Input Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

C2.3/5.0
Behavior2/5

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

Annotations already declare readOnlyHint, idempotentHint and openWorldHint, so the safety profile is largely covered. The description adds nothing beyond that — no note on pagination, result volume, scoping (organization vs global), or whether an empty result is possible, which matters for an "all" listing.

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, but the brevity comes from omission rather than discipline: the entire content is an HTTP verb plus a path fragment, with no front-loaded explanation of what the call returns. Nothing here earns its place as a tool description.

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, annotation-covered read tool the bar is low, but the description still fails to say what a custom role is or what an "all" listing returns or how it is scoped. An agent must rely entirely on the name and annotations to decide whether to invoke it.

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 clarify and the baseline of 4 applies. The empty schema with additionalProperties false is self-documenting.

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 only the raw endpoint string "GET /customRole.all", which essentially restates the tool name rather than explaining the action in plain language. An agent can infer it lists custom roles, but there is no specific verb+resource framing and nothing to distinguish it from sibling read tools such as customRole-getStatements or customRole-membersByRole.

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 when-to-use guidance at all: no mention of when to call this versus customRole-getStatements, customRole-membersByRole, or the other customRole-* siblings. The only implied signal is the "all" in the name, which an agent must guess at.

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