VPS_getProjectContentsV1
Retrieve complete project details, including Docker Compose file contents, metadata, and deployment status, to inspect configurations, review compose files, and assess project health.
Instructions
Retrieves the complete project information including the docker-compose.yml file contents, project metadata, and current deployment status.
This endpoint provides the full configuration and state details of a specific Docker Compose project.
Use this to inspect project settings, review the compose file, or check the overall project health.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| projectName | Yes | Docker Compose project name using alphanumeric characters, dashes, and underscores only | |
| virtualMachineId | Yes | Virtual Machine ID |
Implementation Reference
- types.d.ts:1176-1194 (schema)TypeScript type definition (schema) for the 'VPS_getProjectContentsV1' MCP tool, including JSDoc description, input parameters (virtualMachineId: number, projectName: string), and generic response type.
* Retrieves the complete project information including the docker-compose.yml file contents, project metadata, and current deployment status. This endpoint provides the full configuration and state details of a specific Docker Compose project. Use this to inspect project settings, review the compose file, or check the overall project health. */ "VPS_getProjectContentsV1": { params: { /** * Virtual Machine ID */ virtualMachineId: number; /** * Docker Compose project name using alphanumeric characters, dashes, and underscores only */ projectName: string; }; response: any; // Response structure will depend on the API };