Skip to main content
Get structured source information for a project agent

Tool details

FieldValue
Nameget_agent_source
GroupAgents

Playground

Input schema

Input schema
{
  "type": "object",
  "properties": {
    "project_reference": {
      "type": "string",
      "description": "Project identifier or slug that scopes the tool call."
    },
    "agent_id": {
      "type": "string",
      "description": "Provide the agent id."
    },
    "runtime_target_kind": {
      "anyOf": [
        {
          "type": "string",
          "enum": [
            "production",
            "environment",
            "preview_branch"
          ],
          "description": "Provide the runtime target kind."
        },
        {
          "type": "null",
          "description": "Provide the runtime target kind."
        }
      ],
      "description": "Provide the runtime target kind."
    },
    "target_environment_id": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid",
          "description": "Provide the target environment id."
        },
        {
          "type": "null",
          "description": "Provide the target environment id."
        }
      ],
      "description": "Provide the target environment id."
    },
    "target_branch_id": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid",
          "description": "Provide the target branch id."
        },
        {
          "type": "null",
          "description": "Provide the target branch id."
        }
      ],
      "description": "Provide the target branch id."
    },
    "source_target_kind": {
      "type": "string",
      "enum": [
        "project",
        "production",
        "environment",
        "preview_branch"
      ],
      "description": "Provide the source target kind."
    }
  },
  "required": [
    "project_reference",
    "agent_id"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#",
  "description": "Input schema for the get_agent_source tool."
}

Output schema

Output schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the record."
    },
    "name": {
      "type": "string",
      "description": "Human-readable name for the record."
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "description": "Human-readable description for the record."
    },
    "model": {
      "type": [
        "string",
        "null"
      ],
      "description": "The model associated with this record."
    },
    "system_prompt": {
      "type": [
        "string",
        "null"
      ],
      "description": "The system prompt associated with this record."
    },
    "max_steps": {
      "anyOf": [
        {
          "type": "integer",
          "exclusiveMinimum": 0,
          "description": "The max steps associated with this record."
        },
        {
          "type": "null",
          "description": "The max steps returned by the tool."
        }
      ],
      "description": "The max steps associated with this record."
    },
    "allowed_models": {
      "type": "array",
      "items": {
        "type": "string",
        "description": "One allowed model item associated with this record."
      },
      "description": "List of allowed models associated with this record."
    },
    "skill_ids": {
      "type": "array",
      "items": {
        "type": "string",
        "description": "One skill id item associated with this record."
      },
      "description": "List of skill ids associated with this record."
    },
    "tool_ids": {
      "type": "array",
      "items": {
        "type": "string",
        "description": "One tool id item associated with this record."
      },
      "description": "List of tool ids associated with this record."
    },
    "suggestions": {
      "anyOf": [
        {
          "type": "object",
          "additionalProperties": {
            "description": "Additional structured values associated with this result."
          },
          "description": "Structured suggestions details associated with this record."
        },
        {
          "type": "null",
          "description": "The suggestions returned by the tool."
        }
      ],
      "description": "The suggestions associated with this record."
    },
    "security_enabled": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "The security enabled associated with this record."
    },
    "source_path": {
      "type": "string",
      "description": "The source path associated with this record."
    },
    "source": {
      "type": "string",
      "description": "The source associated with this record."
    },
    "edit_mode": {
      "type": "string",
      "enum": [
        "structured",
        "source_only"
      ],
      "description": "The edit mode associated with this record."
    },
    "source_only_reasons": {
      "type": "array",
      "items": {
        "type": "string",
        "description": "One source only reason item associated with this record."
      },
      "description": "List of source only reasons associated with this record."
    }
  },
  "required": [
    "id",
    "name",
    "description",
    "model",
    "system_prompt",
    "max_steps",
    "allowed_models",
    "skill_ids",
    "tool_ids",
    "suggestions",
    "security_enabled",
    "source_path",
    "source",
    "edit_mode",
    "source_only_reasons"
  ],
  "additionalProperties": false,
  "description": "Structured agent source output schema for MCP tools.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}