Skip to main content

​
Overview

Lists all projects in Dokploy with optimized response size suitable for LLM consumption. Returns summary data including project info, environment counts, and service counts per environment. Excludes large fields like env vars and compose files.

​
Annotations

​
readOnlyHint
boolean
default:"true"
This operation only retrieves data and does not modify any resources.
​
idempotentHint
boolean
default:"true"
This operation is safe to repeat multiple times without side effects.
​
openWorldHint
boolean
default:"true"
This operation interacts with the external Dokploy API.

​
Input Schema

This tool does not require any input parameters. 
{}

​
Response Schema

Returns an array of projects with optimized summary data:
​
projectId
string
Unique identifier for the project
​
name
string
Name of the project
​
description
string | null
Description of the project
​
createdAt
string
ISO 8601 timestamp of when the project was created
​
organizationId
string
ID of the organization that owns this project
​
totalServiceCounts
object
Total service counts across all environments
​
applications
number
Total number of applications
​
postgres
number
Total number of PostgreSQL databases
​
mysql
number
Total number of MySQL databases
​
mariadb
number
Total number of MariaDB databases
​
mongo
number
Total number of MongoDB databases
​
redis
number
Total number of Redis databases
​
compose
number
Total number of compose services
​
environmentCount
number
Total number of environments in this project
​
environments
array
Array of environments with service details
​
environmentId
string
Unique identifier for the environment
​
name
string
Name of the environment
​
description
string | null
Description of the environment
​
createdAt
string
ISO 8601 timestamp of when the environment was created
​
serviceCounts
object
Service counts for this specific environment
​
services
object
Detailed service information including applications, databases, and compose services

​
Usage Example

// List all projects
const result = await mcp.useTool("project-all", {});

console.log(result);
// Output:
// {
//   "message": "Successfully fetched 2 project(s) with environment details",
//   "data": [
//     {
//       "projectId": "proj_123",
//       "name": "Production",
//       "description": "Production environment",
//       "createdAt": "2024-01-15T10:30:00Z",
//       "organizationId": "org_456",
//       "totalServiceCounts": {
//         "applications": 5,
//         "postgres": 2,
//         "mysql": 1,
//         "mariadb": 0,
//         "mongo": 1,
//         "redis": 1,
//         "compose": 0
//       },
//       "environmentCount": 2,
//       "environments": [...]
//     }
//   ]
// }

​
Error Handling

If the API request fails or returns no data, an error response will be returned: 
{
  "error": "Failed to fetch projects",
  "details": "No response data received"
}

​
Notes

  • This operation is optimized for LLM consumption by excluding large fields like environment variables and compose files
  • Returns comprehensive service counts at both project and environment levels
  • Service details include only essential information to minimize response size
  • Safe to call frequently as it’s a read-only operation

Build docs developers (and LLMs) love

Get started for freeTalk to us