Skip to main content
Update a structured agent source file

Tool details

FieldValue
Nameupdate_agent
GroupAgents

Playground

Input schema

Input schema
{
  "type": "object",
  "properties": {
    "project_reference": {
      "type": "string",
      "description": "Project identifier or slug associated with the record."
    },
    "agent_id": {
      "type": "string",
      "minLength": 1,
      "description": "The agent id associated with this record."
    },
    "id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "pattern": "^[a-zA-Z0-9_-]+$",
      "description": "Unique identifier for the record."
    },
    "name": {
      "type": "string",
      "minLength": 1,
      "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",
      "minLength": 1,
      "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": "Provide the max steps."
        }
      ],
      "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": "The allowed models associated with this record."
    },
    "skill_ids": {
      "type": "array",
      "items": {
        "type": "string",
        "description": "One skill id item associated with this record."
      },
      "description": "The skill ids associated with this record."
    },
    "tool_ids": {
      "type": "array",
      "items": {
        "type": "string",
        "description": "One tool id item associated with this record."
      },
      "description": "The tool ids associated with this record."
    },
    "suggestions": {
      "anyOf": [
        {
          "type": "array",
          "items": {
            "anyOf": [
              {
                "type": "string",
                "minLength": 1,
                "description": "The option 1 associated with this record."
              },
              {
                "type": "object",
                "properties": {
                  "title": {
                    "type": "string",
                    "minLength": 1,
                    "description": "Short human-readable title for the record."
                  },
                  "prompt": {
                    "type": "string",
                    "minLength": 1,
                    "description": "The prompt associated with this record."
                  }
                },
                "required": [
                  "title",
                  "prompt"
                ],
                "additionalProperties": false,
                "description": "Structured option 2 details associated with this record."
              }
            ],
            "description": "One suggestion item associated with this record."
          },
          "description": "List of suggestions associated with this record."
        },
        {
          "type": "null",
          "description": "Provide the suggestions."
        }
      ],
      "description": "List of suggestions associated with this record."
    },
    "security_enabled": {
      "type": "boolean",
      "description": "The security enabled associated with this record."
    },
    "source_target_kind": {
      "type": "string",
      "description": "The source target kind associated with this record."
    },
    "target_branch_id": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid",
          "description": "The target branch id associated with this record."
        },
        {
          "type": "null",
          "description": "Provide the target branch id."
        }
      ],
      "description": "The target branch id associated with this record."
    }
  },
  "required": [
    "project_reference",
    "agent_id",
    "name",
    "system_prompt"
  ],
  "additionalProperties": false,
  "description": "Structured update agent input schema for MCP tools.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}

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": "array",
          "items": {
            "anyOf": [
              {
                "type": "string",
                "minLength": 1,
                "description": "The option 1 associated with this record."
              },
              {
                "type": "object",
                "properties": {
                  "title": {
                    "type": "string",
                    "minLength": 1,
                    "description": "Short human-readable title for the record."
                  },
                  "prompt": {
                    "type": "string",
                    "minLength": 1,
                    "description": "The prompt associated with this record."
                  }
                },
                "required": [
                  "title",
                  "prompt"
                ],
                "additionalProperties": false,
                "description": "Structured option 2 details associated with this record."
              }
            ],
            "description": "One suggestion item associated with this record."
          },
          "description": "List of suggestions associated with this record."
        },
        {
          "type": "null",
          "description": "The suggestions returned by the tool."
        }
      ],
      "description": "List of 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#"
}