Install agent

veryfront__install_agent

Requires project.agents.write.

Access

No external-service connection is required. Use a Veryfront credential with access to the requested resources.

Call type: Can change resources.

Arguments

FieldTypeRequiredDescription and constraints
agent_idstringYesCatalog agent identifier. Minimum length: 1.
relationstringNoRelation of the agent access grant that installs the catalog agent. Installing creates or reuses an access grant; the agent is not copied. Default: "editor". Values: "owner", "admin", "editor", "viewer".
project_referencestringNoProject identifier or slug that scopes the tool call. Minimum length: 1.

Example request

Send this JSON-RPC request through an initialized MCP client. Replace sample identifiers and values before calling the tool. See MCP client setup.

json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "veryfront__install_agent",
    "arguments": {
      "agent_id": "example"
    }
  }
}

Result

The published output shape is summarized below. Inspect both the MCP response content and isError when handling a call.

FieldTypeRequiredDescription and constraints
idstringYesUnique identifier for the returned record.
namestringYesHuman-readable name for the returned record.
descriptionstring or nullYesPublic agent summary. Saved system instructions are in the agent source document (get_agent_source).
providerobjectYesStructured provider details associated with this tool result.
versionstringYes
capabilitiesobjectYesStructured capabilities details associated with this tool result.
default_input_modesstring[]YesList of default input modes associated with this tool result.
default_output_modesstring[]YesList of default output modes associated with this tool result.
toolsstring[]YesSource-selected tools summarized by the card as exact tool IDs. An empty array does not establish that tools are disabled. Read saved configuration from the agent source document and source-selected tools and integration readiness from agent capabilities; neither verifies execution grants.
skillsobject[]YesList of skills associated with this tool result.
suggestionsstring or object[] or nullNo
kindstringYesValues: "source_project_agent", "installed_project_agent".
can_runbooleanYesWhether the card supports invocation. When false, inspect runtime_readiness.status and runtime_readiness.reason before starting a run. True does not prove live runtime readiness, model availability, or execution authorization. These are checked when a run starts.
source_typestringYesValues: "project", "catalog_install".
installed_accessobject or nullNo
runtime_readinessobject or nullNoReadiness of a registered push or pull runtime service, when one applies. For a source agent, not_applicable means this service check does not apply; it does not mean the agent cannot run. This field does not verify model availability or execution access.
source_pathstringYes
edit_modestringYesValues: "structured", "source_only".
avatar_urlstring or null or nullNo
modelstring or nullYesModel identifier exposed by the agent card. Null does not mean a model is required or identify the model a run will use. Model selection and availability are checked at run admission.
urlstringYes

Full schemas

json
{
  "type": "object",
  "properties": {
    "agent_id": {
      "type": "string",
      "minLength": 1,
      "description": "Catalog agent identifier."
    },
    "relation": {
      "type": "string",
      "enum": [
        "owner",
        "admin",
        "editor",
        "viewer"
      ],
      "description": "Relation of the agent access grant that installs the catalog agent. Installing creates or reuses an access grant; the agent is not copied.",
      "default": "editor"
    },
    "project_reference": {
      "type": "string",
      "minLength": 1,
      "description": "Project identifier or slug that scopes the tool call."
    }
  },
  "required": [
    "agent_id"
  ],
  "additionalProperties": false,
  "description": "Arguments for the install_agent tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}
json
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the returned record."
    },
    "name": {
      "type": "string",
      "description": "Human-readable name for the returned record."
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "description": "Public agent summary. Saved system instructions are in the agent source document (get_agent_source)."
    },
    "provider": {
      "type": "object",
      "properties": {
        "organization": {
          "type": "string"
        },
        "url": {
          "type": "string"
        }
      },
      "required": [
        "organization",
        "url"
      ],
      "additionalProperties": false,
      "description": "Structured provider details associated with this tool result."
    },
    "version": {
      "type": "string"
    },
    "capabilities": {
      "type": "object",
      "properties": {
        "streaming": {
          "type": "boolean"
        },
        "push_notifications": {
          "type": "boolean"
        },
        "extensions": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "List of extensions associated with this tool result."
        }
      },
      "required": [
        "streaming",
        "push_notifications",
        "extensions"
      ],
      "additionalProperties": false,
      "description": "Structured capabilities details associated with this tool result."
    },
    "default_input_modes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of default input modes associated with this tool result."
    },
    "default_output_modes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of default output modes associated with this tool result."
    },
    "tools": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Source-selected tools summarized by the card as exact tool IDs. An empty array does not establish that tools are disabled. Read saved configuration from the agent source document and source-selected tools and integration readiness from agent capabilities; neither verifies execution grants."
    },
    "skills": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier for the returned record."
          },
          "name": {
            "type": "string",
            "description": "Human-readable name for the returned record."
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "description": "Human-readable description returned by the tool."
          },
          "tags": {
            "anyOf": [
              {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "List of tags associated with this tool result."
              },
              {
                "type": "null",
                "description": "The tags returned by the tool."
              }
            ]
          },
          "examples": {
            "anyOf": [
              {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "List of examples associated with this tool result."
              },
              {
                "type": "null",
                "description": "The examples returned by the tool."
              }
            ]
          }
        },
        "required": [
          "id",
          "name"
        ],
        "additionalProperties": false
      },
      "description": "List of skills associated with this tool result."
    },
    "suggestions": {
      "anyOf": [
        {
          "type": "array",
          "items": {
            "anyOf": [
              {
                "type": "string",
                "minLength": 1
              },
              {
                "type": "object",
                "properties": {
                  "title": {
                    "type": "string",
                    "minLength": 1,
                    "description": "Short human-readable title returned by the tool."
                  },
                  "prompt": {
                    "type": "string",
                    "minLength": 1
                  }
                },
                "required": [
                  "title",
                  "prompt"
                ],
                "additionalProperties": false,
                "description": "Structured option 2 details associated with this tool result."
              }
            ]
          },
          "description": "List of suggestions associated with this tool result."
        },
        {
          "type": "null",
          "description": "The suggestions returned by the tool."
        }
      ]
    },
    "kind": {
      "type": "string",
      "enum": [
        "source_project_agent",
        "installed_project_agent"
      ]
    },
    "can_run": {
      "type": "boolean",
      "description": "Whether the card supports invocation. When false, inspect runtime_readiness.status and runtime_readiness.reason before starting a run. True does not prove live runtime readiness, model availability, or execution authorization. These are checked when a run starts."
    },
    "source_type": {
      "type": "string",
      "enum": [
        "project",
        "catalog_install"
      ]
    },
    "installed_access": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "grant_id": {
              "type": "string",
              "format": "uuid"
            },
            "relation": {
              "type": "string",
              "enum": [
                "owner",
                "admin",
                "editor",
                "viewer"
              ]
            },
            "service_account_id": {
              "type": "string",
              "format": "uuid"
            },
            "project_id": {
              "type": "string",
              "format": "uuid",
              "description": "Project identifier associated with this result."
            },
            "status": {
              "type": "string",
              "description": "Lifecycle status for the returned record."
            }
          },
          "required": [
            "grant_id",
            "relation",
            "service_account_id",
            "project_id",
            "status"
          ],
          "additionalProperties": false,
          "description": "Structured installed access details associated with this tool result."
        },
        {
          "type": "null",
          "description": "The installed access returned by the tool."
        }
      ]
    },
    "runtime_readiness": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "status": {
              "type": "string",
              "enum": [
                "ready",
                "offline",
                "not_applicable",
                "unknown"
              ],
              "description": "Lifecycle status for the returned record."
            },
            "reason": {
              "type": [
                "string",
                "null"
              ]
            },
            "runtime_target_kind": {
              "anyOf": [
                {
                  "type": "string",
                  "enum": [
                    "registered_push_service",
                    "pull_worker"
                  ]
                },
                {
                  "type": "null",
                  "description": "The runtime target kind returned by the tool."
                }
              ]
            },
            "runtime_service_key": {
              "type": [
                "string",
                "null"
              ]
            }
          },
          "required": [
            "status",
            "reason",
            "runtime_target_kind",
            "runtime_service_key"
          ],
          "additionalProperties": false,
          "description": "Readiness of a registered push or pull runtime service, when one applies. For a source agent, not_applicable means this service check does not apply; it does not mean the agent cannot run. This field does not verify model availability or execution access."
        },
        {
          "type": "null",
          "description": "The runtime readiness returned by the tool."
        }
      ],
      "description": "Readiness of a registered push or pull runtime service, when one applies. For a source agent, not_applicable means this service check does not apply; it does not mean the agent cannot run. This field does not verify model availability or execution access."
    },
    "source_path": {
      "type": "string"
    },
    "edit_mode": {
      "type": "string",
      "enum": [
        "structured",
        "source_only"
      ]
    },
    "avatar_url": {
      "anyOf": [
        {
          "anyOf": [
            {
              "type": "string",
              "format": "uri"
            },
            {
              "type": "null",
              "description": "The avatar url returned by the tool."
            }
          ]
        },
        {
          "type": "null",
          "description": "The avatar url returned by the tool."
        }
      ]
    },
    "model": {
      "type": [
        "string",
        "null"
      ],
      "description": "Model identifier exposed by the agent card. Null does not mean a model is required or identify the model a run will use. Model selection and availability are checked at run admission."
    },
    "url": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "name",
    "description",
    "provider",
    "version",
    "capabilities",
    "default_input_modes",
    "default_output_modes",
    "tools",
    "skills",
    "kind",
    "can_run",
    "source_type",
    "source_path",
    "edit_mode",
    "model",
    "url"
  ],
  "additionalProperties": false,
  "description": "Structured result returned by the install_agent tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}