Skip to main content
Glama

dokploy_compose_clearDeployments

dokploy_compose_clearDeployments

Clear all deployments associated with a specific Docker Compose configuration in Dokploy to remove outdated or unused resources.

Instructions

[compose] compose.clearDeployments (POST)

Parameters:

  • composeId (string, required)

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
composeIdYes
Behavior2/5

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

Annotations indicate it's not read-only, not destructive, not idempotent, and open-world. The description adds no behavioral context beyond the parameter, such as what 'clear' entails (e.g., deletion, archiving), permissions needed, or side effects. With annotations present but minimal description, it fails to add meaningful value.

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

Conciseness3/5

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

The description is brief and front-loaded with the tool name and HTTP method, but it wastes space on redundant formatting (brackets, parentheses) and lacks efficient information delivery. It's concise but under-specified, not optimally structured.

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?

Given 1 parameter with 0% schema coverage, no output schema, and annotations that don't fully explain behavior, the description is incomplete. It doesn't clarify what 'clearDeployments' does, its outcomes, or error conditions, making it inadequate for safe use.

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. It only lists 'composeId' as a required string without explaining its format, source, or purpose. No additional meaning is provided beyond the schema, leaving the parameter poorly understood.

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

Purpose3/5

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

The description states the tool clears deployments for a compose, which is a specific verb+resource. However, it doesn't distinguish from sibling tools like 'dokploy_application_clearDeployments' or 'dokploy_compose_cleanQueues', leaving the scope unclear. The purpose is identifiable but lacks differentiation.

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?

No guidance on when to use this tool versus alternatives is provided. The description only lists the parameter without context, prerequisites, or exclusions. This leaves the agent without usage direction.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/jarciahdz111/dokploy-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server