Skip to main content
Install a catalog agent into selected projects by granting explicit project agent access to each project

Tool details

FieldValue
Nameinstall_agent_for_projects
GroupAgents

Playground

Input schema

Input schema
{
  "type": "object",
  "properties": {
    "project_reference": {
      "type": "string",
      "minLength": 1,
      "description": "Project identifier or slug that scopes the tool call."
    },
    "agent_id": {
      "type": "string",
      "minLength": 1,
      "description": "Provide the agent id."
    },
    "project_ids": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid",
        "description": "One project id item supplied to the tool."
      },
      "minItems": 1,
      "maxItems": 100,
      "description": "Provide one or more project id values."
    },
    "relation": {
      "type": "string",
      "enum": [
        "owner",
        "admin",
        "editor",
        "viewer"
      ],
      "description": "Provide the relation.",
      "default": "editor"
    }
  },
  "required": [
    "project_reference",
    "agent_id",
    "project_ids"
  ],
  "additionalProperties": false,
  "description": "Input schema for the install_agent_for_projects tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Output schema

Output schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "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."
          },
          "provider": {
            "type": "object",
            "additionalProperties": {
              "description": "Additional structured values associated with this result."
            },
            "description": "Structured provider details associated with this record."
          },
          "version": {
            "type": "string",
            "description": "The version associated with this record."
          },
          "capabilities": {
            "type": "object",
            "additionalProperties": {
              "description": "Additional structured values associated with this result."
            },
            "description": "Structured capabilities details associated with this record."
          },
          "default_input_modes": {
            "type": "array",
            "items": {
              "type": "string",
              "description": "One default input mode item associated with this record."
            },
            "description": "List of default input modes associated with this record."
          },
          "default_output_modes": {
            "type": "array",
            "items": {
              "type": "string",
              "description": "One default output mode item associated with this record."
            },
            "description": "List of default output modes associated with this record."
          },
          "tools": {
            "type": "array",
            "items": {
              "type": "string",
              "description": "One tool item associated with this record."
            },
            "description": "List of tools associated with this record."
          },
          "skills": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": {
                "description": "Additional structured values associated with this result."
              },
              "description": "One skill item associated with this record."
            },
            "description": "List of skills 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": "The suggestions associated with this record."
          },
          "model": {
            "type": [
              "string",
              "null"
            ],
            "description": "The model associated with this record."
          },
          "url": {
            "type": "string",
            "description": "The url associated with this record."
          },
          "kind": {
            "type": "string",
            "enum": [
              "source_project_agent",
              "installed_project_agent"
            ],
            "description": "The kind associated with this record."
          },
          "can_run": {
            "type": "boolean",
            "description": "The can run associated with this record."
          },
          "source_type": {
            "type": "string",
            "enum": [
              "project",
              "catalog_install"
            ],
            "description": "The source type associated with this record."
          },
          "installed_access": {
            "anyOf": [
              {
                "type": "object",
                "additionalProperties": {
                  "description": "Additional structured values associated with this result."
                },
                "description": "Structured installed access details associated with this record."
              },
              {
                "type": "null",
                "description": "The installed access returned by the tool."
              }
            ],
            "description": "The installed access associated with this record."
          },
          "runtime_readiness": {
            "type": "object",
            "additionalProperties": {
              "description": "Additional structured values associated with this result."
            },
            "description": "Structured runtime readiness details associated with this record."
          },
          "source_path": {
            "type": "string",
            "description": "The source path associated with this record."
          },
          "edit_mode": {
            "type": "string",
            "enum": [
              "structured",
              "source_only"
            ],
            "description": "The edit mode associated with this record."
          }
        },
        "required": [
          "id",
          "name",
          "description",
          "provider",
          "version",
          "capabilities",
          "default_input_modes",
          "default_output_modes",
          "tools",
          "skills",
          "suggestions",
          "model",
          "url",
          "kind",
          "can_run",
          "source_type",
          "installed_access",
          "runtime_readiness",
          "source_path",
          "edit_mode"
        ],
        "additionalProperties": false,
        "description": "Structured agent output schema for MCP tools."
      },
      "description": "Primary result records returned by the tool."
    }
  },
  "required": [
    "data"
  ],
  "additionalProperties": false,
  "description": "Structured result returned by the install_agent_for_projects tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}