Skip to main content
Glama
MCP Dokploy Online
by igoruam

environment-byProjectId

Read-onlyIdempotent

Retrieves environment details for a specific Dokploy project by project ID, enabling inspection of project-level environment configuration.

Instructions

GET /environment.byProjectId

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": {
      "projectId": "<projectId>"
    },
    "name": "environment-byProjectId"
  }
}

Input Schema

NameRequiredDescriptionDefault
projectIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

C2/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 covered externally, but the description adds nothing beyond that: no indication of whether the result is a list or a single environment, no pagination, ordering, or empty-result behavior. It does not contradict the annotations, but it contributes zero 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 short with no filler, but that brevity reflects under-specification rather than discipline. A bare HTTP verb-plus-route is not a front-loaded explanation an agent can act on.

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 simple one-parameter read tool with annotations and no output schema, a sentence stating that it returns the environments for a given project would have sufficed. As written, the agent cannot tell whether the return is a collection or a single object, nor how it relates to the sibling environment lookups.

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 schema gives only the name and type of projectId. The route fragment 'byProjectId' implies the parameter selects environments belonging to that project, but format, source of the id, and filtering behavior are undocumented anywhere.

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 route string, "GET /environment.byProjectId", which only obliquely conveys purpose: it appears to fetch environments scoped to a project. It never states in words what the tool does or how it differs from the sibling environment-one or environment-search beyond the embedded path fragment.

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 mention of when this is preferred over environment-one or environment-search, and no prerequisites. The path segment 'byProjectId' is the only hint that this is a project-scoped 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