Skip to main content
Glama
MCP Dokploy Online
by igoruam

customRole-membersByRole

Read-onlyIdempotent

Retrieve all members assigned to a specific custom role in Dokploy by providing the role name, so you can review role-based membership.

Instructions

GET /customRole.membersByRole

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": {
      "roleName": "<roleName>"
    },
    "name": "customRole-membersByRole"
  }
}

Input Schema

NameRequiredDescriptionDefault
roleNameYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

C2.2/5.0
Behavior2/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true and openWorldHint=true, so the safety profile is covered structurally. The description adds nothing beyond that: no note on what happens with an unknown roleName, whether the result is paginated, or what openWorld access implies here. It does not contradict the annotations, but it contributes no behavioral context.

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 technically short and front-loaded, but the brevity comes from under-specification rather than efficiency. A raw route string is not a usable description for an agent that cannot see the HTTP layer.

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?

With one required parameter, no output schema, and no annotations explaining results, the description should at minimum say what the call returns and what roleName refers to. It supplies neither, leaving the agent to guess at the return shape and semantics.

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

Parameters3/5

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

Only one parameter (roleName) exists and schema description coverage is 0%, so the description would need to explain its meaning and format. It does not, but the parameter is a single self-describing required string named roleName, which keeps the gap small rather than severe.

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 a raw endpoint restatement, "GET /customRole.membersByRole", which only implies a read of custom-role membership by role. It does not state in plain terms what is returned (a member list? a count?) or how this differs from siblings such as customRole-all or customRole-getStatements. This is close to tautology against the tool name.

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, no prerequisite (e.g. needing a role name to exist), and no mention of the obvious alternative customRole-all for listing roles. The agent must infer from the name alone that this is the per-role member lookup.

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