Back to home
Connect a client

Get a project

Read project settings, status, the current runtime port, its source and lock timestamp, and the app's size: size (256mb, 512mb, 1gb, 2gb, 4gb or 8gb), sizeName and memorySizeBytes, the most memory the app may use. outOfMemory is set when the app was stopped for running out of memory at its current size in the last 24 hours: lastAt is when it last happened and countLast24h how many times; it is null otherwise, and goes back to null once the size changes. To give the app more memory, send updateProject with the next size up. detectedRuntime says what the latest deploy runs and why: summary, such as "Static site (public/)" or "Node app (npm start)", and reason; for a static site, unknownPaths is what a path with no file gets (index: the home page, 404: a 404 page, auto: the home page unless the site has a 404.html) and autoUnknownPaths what the auto setting would pick. detectedRuntime is null before a deploy has recorded it. staticUnknownPaths is the setting itself (auto, spa or not_found), null on a project created before it existed, which serves the home page. If the control plane is unavailable, runtimePortStatusUnavailable is true and the port and size fields are null. Secret values are excluded.

Arguments

NameTypeRequiredLimits
projectIdstringYesAt least 1 character(s)
Full input schema
{
  "type": "object",
  "properties": {
    "projectId": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "projectId"
  ],
  "additionalProperties": false
}

Example call

The params of a tools/call request. Replace the placeholder values with your own IDs.

{
  "name": "getProject",
  "arguments": {
    "projectId": "REPLACE_WITH_PROJECT_ID"
  }
}

Result

The same data as the API operation, wrapped as {"untrusted_data": true, "source": "getProject", "note": "...", "data": ...} so the model treats project content as data, not instructions.