Tools

get_project

One project's details.

Access token · read · Read only

Parameters

projectId string required

The project's id (from list_projects).

View schema

{
  "description": "The project's id (from list_projects).",
  "type": "string",
  "format": "uuid",
  "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}

Request example

{
  "name": "get_project",
  "arguments": {
    "projectId": "00000000-0000-4000-8000-000000000001"
  }
}

Replace example values with ids and arguments read from your own Heavenly account. This example does not execute a tool.

Returns

The requested project details from the workspace API, with credential fields removed. Only projects accessible to the token account can be read.

Account access and permissions are checked by Heavenly. See errors for failure handling.