MCP Documentation

Welcome to our comprehensive MCP reference documentation. This MCP provides a complete suite of endpoints for managing cloud-based projects, deployments, and applications. Whether you're building web applications, managing microservices, or orchestrating containerized deployments, our platform offers the tools you need to streamline your development workflow.

Key Features

Our MCP tools enables you to:

• Project Management - Create, configure, and manage projects with support for VCS repositories, Docker images, and direct file uploads
• Deployment Control - Deploy applications, monitor build processes, and manage deployment lifecycle
• Environment Configuration - Set up multiple environments (development, staging, production) with custom variables and resources
• Domain Management - Configure custom domains and SSL certificates for your projects
• Analytics & Monitoring - Access detailed analytics, logs, and performance metrics
• Security - Run security scans and manage API keys with fine-grained access control
• GitHub Integration - Connect repositories, monitor branches, and trigger automated deployments
• Application Organization - Group related projects and services using the Apps feature

Tools list

1. AddProjectsToApp
Add projects to app - Associates one or more projects with an app

2. AddServicesToApp
Add services to app - Associates one or more services with an app

3. AssignDeploymentToProjectEnvironment
Assign deployment to environment - Assigns a deployment to a project environment

4. CancelDeployment
Cancel deployment - Cancels a deployment that is in queue or building state

5. CheckAPIKeyUniqueName
Check if API key name is available - Checks if an API key name is available for the authenticated user

6. CheckProjectEnvironmentUniqueName
Check if environment unique name is available - Checks if an environment unique name is available for a project

7. CheckProjectUniqueName
Check if project unique name is available - Checks if a project unique name is available for the authenticated user

8. CreateAPIKey
Create API key - Creates a new API key for the authenticated user

9. CreateApp
Create app - Creates a new app to organize projects and services

10. CreateDeployment
Create deployment - Creates a new deployment for an image type project. The image must be a valid Docker image reference that exists in the registry. This endpoint is only available for image type projects.

11. CreateDomain
Create domain - Adds a custom domain to a project. The domain must be unique and not already in use by another project.

12. CreateProject
Create a new project - Creates a new project with source code configuration and build settings. The project can be linked to a VCS repository (e.g., GitHub) and configured with framework/runtime settings for automated builds and deployments.

13. CreateProjectEnvironment
Create project environment - Creates a new environment for a project. For VCS projects: branch is required and must exist in the repository. For image projects: branch should be omitted or null.

14. DeleteApp
Delete app - Deletes an app. Projects and services associated with the app will have their app_id set to null.

15. DeleteDeployment
Delete deployment - Marks a deployment for deletion

16. DeleteDomain
Delete domain - Deletes a custom domain from the project

17. DeleteProject
Delete project - Marks a project for deletion. The project will be asynchronously deleted along with all associated resources.

18. DeleteProjectEnvironment
Delete project environment - Deletes a project environment

19. DownloadDeployment
Download deployment files - Gets a signed URL to download the deployment files. Only available for upload type projects.

20. GetBuildLogs
Get build logs - Retrieves build logs for a deployment

21. GetCurrentUser
Get current user - Returns information about the currently authenticated user

22. GetDeployment
Get deployment - Retrieves detailed information about a specific deployment

23. GetDeploymentLogs
Get deployment logs - Retrieves runtime logs for a deployed application

24. GetEnvAnalyticsReqDistribution
Get request distribution by status - Retrieves request distribution grouped by HTTP status code for a project environment.

25. GetGithubRepositoryContent
Get repository content - Retrieves the file tree structure of a repository

26. GetProject
Get project by ID - Retrieves detailed information about a specific project

27. GetProjectEnvironmentAnalytics
Get environment analytics - Retrieves comprehensive analytics data for a project environment including overall requests, request distribution, RPM, success percentage, top hit paths, and top error paths. Supports custom time ranges via start and end parameters.

28. GetProjectEnvironmentAnalyticsOverallRequests
Get overall request statistics - Retrieves overall request statistics including total requests, success (2xx), client errors (4xx), and server errors (5xx) for a project environment.

29. GetProjectEnvironmentAnalyticsRequestsOverTime
Get requests over time - Retrieves time series data for requests broken down by status code ranges (2xx, 3xx, 4xx, 5xx) for a project environment.

30. GetProjectEnvironmentAnalyticsRPM
Get RPM (Requests Per Minute) statistics - Retrieves RPM statistics including peak and average requests per minute for a project environment.

31. GetProjectEnvironmentAnalyticsSuccessPercentage
Get success percentage - Retrieves the success percentage (2xx + 3xx responses) for a project environment.

32. GetProjectEnvironmentAnalyticsTopErrorPaths
Get top 10 error paths - Retrieves the top 10 paths with the most errors (4xx and 5xx status codes) for a project environment.

33. GetProjectEnvironmentAnalyticsTopHitPaths
Get top 10 hit paths - Retrieves the top 10 most frequently accessed paths for a project environment.

34. GetProjectEnvironmentLogs
Get environment logs - Retrieves runtime logs for a project environment

35. GetProjectTransferUri
Get project transfer URI - Generates a transfer URI and token that can be used to transfer project ownership to another user. The token is valid for 6 hours.

36. GetQuotas
Get global quotas - Returns the current usage quotas for the authenticated user including projects and API keys limits

37. GetSecurityScan
Get security scan report - Retrieves the security scan report for a deployment

38. GetSecurityScanDownloadUri
Download security scan report - Gets a signed URL to download the full security scan report. Only available when the scan status is successful.

39. GetSupportedProjectTypes
Get supported project types - Returns the list of supported frameworks and runtimes

40. InstallGithubApp
Install GitHub App - Connects a GitHub App installation to the user's account

41. ListAPIKeys
List API keys - Returns all API keys for the authenticated user

42. ListApps
List apps - Returns all apps for the authenticated user

43. ListConnectedGithubAccounts
List connected GitHub accounts - Returns a list of all GitHub accounts connected to the user

44. ListDeployments
List deployments - Returns all deployments for a project

45. ListDomains
List domains - Returns all custom domains for a project

46. ListGithubRepositories
List GitHub repositories - Lists all repositories accessible through a GitHub installation

47. ListGithubRepositoryBranches
List repository branches - Lists all branches for a GitHub repository

48. ListProjectEnvironments
List project environments - Returns all environments for a project

49. ListProjects
List all projects - Returns a list of all projects for the authenticated user

50. ListProjectsByApp
List projects by app - Returns all projects associated with an app

51. ListProjectTransferHistory
List project transfer history - Returns the transfer history of a project, showing all ownership transfers that have occurred.

52. ListServicesByApp
List services by app - Returns all services associated with an app

53. RefreshDomain
Refresh domain - Triggers a refresh of the domain verification. Only available for domains in pending status.

54. RemoveProjectsFromApp
Remove projects from app - Removes one or more projects from an app by setting their app_id to null

55. RemoveServicesFromApp
Remove services from app - Removes one or more services from an app by setting their app_id to null

56. RetriggerDeployment
Retrigger deployment - Creates a new deployment with the same source as an existing deployment. The settings can be taken from either the project (current project settings) or the original deployment (deployment settings) only works when VCS.

57. RetriggerSecurityScan
Retrigger security scan - Retriggers a failed security scan. Only available when the scan status is failed.

58. RevokeAPIKey
Revoke API key - Revokes an API key, making it unusable

59. TransferProject
Transfer project ownership - Transfers project ownership to the authenticated user using a valid transfer token. The token must be obtained from the transfer-uri endpoint by the current project owner.

60. TriggerLatestDeployment
Trigger latest deployment - Triggers a new deployment for the latest commit on the specified branch (or default branch if not specified). Only available for VCS projects.

61. TriggerSecurityScan
Trigger security scan - Creates and triggers a new security scan for a deployment. Security scanning must be enabled for the project.

62. UpdateAPIKey
Update API key - Updates the name and description of an API key

63. UpdateApp
Update app - Updates an app's name, description, and color

64. UpdateDomainEnvironment
Update domain environment - Updates the environment assignment for a domain. The domain must be in active status.

65. UpdateProject
Update project - Updates project display name and description

66. UpdateProjectEnvironment
Update project environment - Updates environment description, branch (for VCS projects), and auto-promote settings. For VCS projects: branch is required and must exist in the repository. For image projects: branch should be omitted or null.

67. UpdateProjectEnvironmentEnvironmentVariables
Update environment variables - Updates runtime environment variables and settings for an environment. For image projects: can update both port and runEnvs. For VCS projects: can only update runEnvs.

68. UpdateProjectEnvironmentResources
Update environment resources - Updates CPU, memory, and replica settings for an environment

69. UpdateProjectSettings
Update project settings - Updates build and runtime settings for a project. For VCS projects: accepts VCSSettings schema with all build/runtime configuration options. For image projects: accepts ImageSettings schema with port and runtime environment variables. For upload projects: accepts UploadSettings schema with build and runtime configuration options.

70. UploadDeploymentBase64Files
Upload deployment files (Base64) - Creates a new deployment by uploading base64-encoded files. Only available for upload type projects. File contents must be base64-encoded.

71. UploadDeploymentFiles
Upload deployment files - Creates a new deployment by uploading files directly. Only available for upload type projects. Files are provided as an array of path/content pairs.

72. UploadDeploymentZip
Upload deployment as ZIP - Creates a new deployment by uploading a ZIP file. Only available for upload type projects.

73. WakeupDeployment
Wake up deployment - Wakes up a sleeping deployment by transitioning it to deploying state. If the project has reached the maximum number of deployed deployments, the oldest deployed deployment will be terminated to make room.