Skip to main content
Get the normalized project tool-access visibility profile for agents and runtime consumers

Tool details

FieldValue
Nameget_tool_access_profile
GroupFiles

Playground

Input schema

Input schema
{
  "type": "object",
  "properties": {
    "project_reference": {
      "type": "string",
      "description": "Project ID or slug"
    }
  },
  "required": [
    "project_reference"
  ],
  "additionalProperties": false,
  "description": "Input schema for the get_tool_access_profile tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Output schema

Output schema
{
  "type": "object",
  "properties": {
    "version": {
      "type": "number",
      "const": 1,
      "description": "The version associated with this tool result."
    },
    "freshness": {
      "type": "object",
      "properties": {
        "resolved_at": {
          "type": "string",
          "format": "date-time",
          "description": "The resolved at associated with this tool result."
        },
        "valid_for_ms": {
          "type": "integer",
          "exclusiveMinimum": 0,
          "description": "The valid for ms associated with this tool result."
        },
        "fail_closed_on_expiry": {
          "type": "boolean",
          "const": true,
          "description": "The fail closed on expiry associated with this tool result."
        }
      },
      "required": [
        "resolved_at",
        "valid_for_ms",
        "fail_closed_on_expiry"
      ],
      "additionalProperties": false,
      "description": "Structured freshness details associated with this tool result."
    },
    "inputs": {
      "type": "object",
      "properties": {
        "capabilities": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "project.read",
              "project.settings.manage",
              "project.delete",
              "project.members.read",
              "project.members.manage",
              "project.invites.read",
              "project.invites.manage",
              "project.files.read",
              "project.files.write",
              "project.files.admin",
              "project.uploads.read",
              "project.uploads.write",
              "project.uploads.admin",
              "project.knowledge.read",
              "project.knowledge.write",
              "project.releases.read",
              "project.releases.write",
              "project.deployments.read",
              "project.deployments.write",
              "project.deploy.execute",
              "project.runtime.manage",
              "project.domains.write",
              "project.environments.manage",
              "project.env_vars.write",
              "project.jobs.read",
              "project.jobs.write",
              "project.agents.read",
              "project.agents.write",
              "project.conversations.read",
              "project.conversations.write",
              "project.integrations.read",
              "project.integrations.connect",
              "project.integrations.configure",
              "project.api_keys.read",
              "project.api_keys.manage",
              "project.cache.read",
              "project.cache.write",
              "project.logs.read",
              "project.resources.read"
            ],
            "description": "One capability item associated with this tool result."
          },
          "description": "List of capabilities associated with this tool result."
        },
        "billing": {
          "type": "object",
          "properties": {
            "collaboration_allowed": {
              "type": "boolean",
              "description": "The collaboration allowed associated with this tool result."
            },
            "can_invite": {
              "type": "boolean",
              "description": "The can invite associated with this tool result."
            }
          },
          "required": [
            "collaboration_allowed",
            "can_invite"
          ],
          "additionalProperties": false,
          "description": "Structured billing details associated with this tool result."
        },
        "entitlements": {
          "type": "object",
          "properties": {
            "dedicated_runtime": {
              "type": "boolean",
              "description": "The dedicated runtime associated with this tool result."
            },
            "custom_domains": {
              "type": "boolean",
              "description": "The custom domains associated with this tool result."
            },
            "export_apps": {
              "type": "boolean",
              "description": "The export apps associated with this tool result."
            }
          },
          "required": [
            "dedicated_runtime",
            "custom_domains",
            "export_apps"
          ],
          "additionalProperties": false,
          "description": "Structured entitlements details associated with this tool result."
        }
      },
      "required": [
        "capabilities",
        "billing",
        "entitlements"
      ],
      "additionalProperties": false,
      "description": "Structured inputs details associated with this tool result."
    },
    "families": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "family": {
            "type": "string",
            "enum": [
              "collaboration",
              "runtime",
              "domains",
              "export"
            ],
            "description": "The family associated with this tool result."
          },
          "default_decision": {
            "type": "object",
            "properties": {
              "visibility": {
                "type": "string",
                "enum": [
                  "visible",
                  "hidden"
                ],
                "description": "The visibility associated with this tool result."
              },
              "reason_code": {
                "type": "string",
                "enum": [
                  "allowed",
                  "missing_capability",
                  "billing_plan_restriction",
                  "billing_seat_limit",
                  "target_not_supported",
                  "resource_state_restriction",
                  "policy_exception",
                  "unknown"
                ],
                "description": "The reason code associated with this tool result."
              },
              "message": {
                "type": "string",
                "description": "The message associated with this tool result."
              }
            },
            "required": [
              "visibility",
              "reason_code"
            ],
            "additionalProperties": false,
            "description": "Structured default decision details associated with this tool result."
          },
          "action_overrides": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "action": {
                  "type": "string",
                  "enum": [
                    "create_invite",
                    "delete_member",
                    "create_server",
                    "delete_server",
                    "create_domain",
                    "download_release"
                  ],
                  "description": "The action associated with this tool result."
                },
                "decision": {
                  "$ref": "#/properties/families/items/properties/default_decision",
                  "description": "The decision returned by the tool."
                }
              },
              "required": [
                "action",
                "decision"
              ],
              "additionalProperties": false,
              "description": "One action override item associated with this tool result."
            },
            "description": "List of action overrides associated with this tool result."
          }
        },
        "required": [
          "family",
          "default_decision",
          "action_overrides"
        ],
        "additionalProperties": false,
        "description": "One family item associated with this tool result."
      },
      "description": "List of families associated with this tool result."
    }
  },
  "required": [
    "version",
    "freshness",
    "inputs",
    "families"
  ],
  "additionalProperties": false,
  "description": "Structured result returned by the get_tool_access_profile tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}