Skip to main content
Glama

Deploy a docker-compose project

deploy_docker_compose

Deploy a Docker Compose application to a remote server: clone or update Git repo, install Docker, write .env, and run compose up.

Instructions

Clones (or updates) a git repo containing a docker-compose.yml, installs Docker if missing, writes a .env file if provided, and runs docker compose up -d --build.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
hostYesServer IP address or hostname, e.g. 168.119.45.12
portNoSSH port, defaults to 22
branchNoGit branch to checkout
appNameYesShort name for this app, used as the directory name
repoUrlYesGit repo URL containing docker-compose.yml at its root
usernameYesSSH username, e.g. root or deploy
passphraseNoPassphrase for the private key, if it has one
envFileContentNoContents to write as .env next to docker-compose.yml
privateKeyPathYesPath to the private key on THIS machine, e.g. "~/.ssh/id_ed25519"
Behavior4/5

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

With no annotations, the description carries full burden for behavioral disclosure. It clearly states the tool clones/updates a git repo, installs Docker if missing, writes a .env file if provided, and runs docker compose up -d --build. This covers major side effects (Docker installation, file creation). However, it does not mention prerequisites like git existing, potential overwriting of existing files, or what happens on failure. Still, it is fairly transparent.

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?

The description is a single concise sentence that front-loads the main action and lists key steps. Every phrase is necessary, and there is no fluff. It is appropriately sized for the tool's complexity.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With 9 parameters, no output schema, and no annotations, the description covers the main workflow but misses important details like parameter relationships, success criteria, or what happens when Docker is already installed. The sibling tools are diverse, and more context on when to use this over exec or write_file would improve completeness. It is adequate but has gaps.

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?

Schema description coverage is 100%, so the input schema already documents all 9 parameters with individual descriptions. The tool description adds minimal extra meaning beyond providing a high-level workflow (e.g., 'writes a .env file if provided' maps to envFileContent). With full schema coverage, a baseline of 3 is appropriate, and the description does not significantly enhance parameter understanding.

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

Purpose5/5

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

The title and description clearly state it deploys a docker-compose project. The description enumerates specific steps (clone/update git repo, install Docker, write .env file, run docker compose up -d --build), making the purpose very specific. It distinguishes from sibling tools like deploy_python_bot, exec, and write_file.

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?

The description implies usage for docker-compose projects but provides no explicit guidelines on when to use or avoid this tool. No alternatives are mentioned, and there is no discussion of prerequisites or scenarios where exec or write_file might be preferred. The context from sibling tools offers some implicit differentiation, but the description itself lacks guidance.

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/wellmb/DPloy'

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