Skip to main content

​
Overview

Retrieves detailed information about a specific project in Dokploy using its unique project ID.

​
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

​
projectId
string
required
The ID of the project to retrieve.

​
Response Schema

Returns the complete project object with all its properties:
​
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
​
env
string
Environment variables for the project
​
environments
array
Array of environments associated with this project, including all services and configurations

​
Usage Example

// Get a specific project by ID
const result = await mcp.useTool("project-one", {
  projectId: "proj_abc123"
});

console.log(result);
// Output:
// {
//   "message": "Successfully fetched project \"proj_abc123\"",
//   "data": {
//     "projectId": "proj_abc123",
//     "name": "My Production Project",
//     "description": "Main production environment",
//     "createdAt": "2024-01-15T10:30:00Z",
//     "organizationId": "org_456",
//     "env": "NODE_ENV=production\nAPI_URL=https://api.example.com",
//     "environments": [
//       {
//         "environmentId": "env_789",
//         "name": "production",
//         "applications": [...],
//         "postgres": [...],
//         "mysql": [...]
//       }
//     ]
//   }
// }

​
Error Handling

If the project is not found or the API request fails, an error response will be returned: 
{
  "error": "Failed to fetch project",
  "details": "Project with ID \"proj_abc123\" not found"
}

​
Notes

  • Returns the complete project data including all environments and services
  • Use this when you need detailed information about a specific project
  • For listing multiple projects with optimized data, use project-all instead
  • The projectId must be a valid, existing project ID

Build docs developers (and LLMs) love

Get started for freeTalk to us