Skip to main content
Get detailed configuration for a specific integration including authentication setup, required environment variables, available tools, and prompts.

Tool details

FieldValue
Nameget_integration
GroupIntegrations

Playground

Input schema

Input schema
{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Integration name (e.g., \"gmail\", \"slack\", \"github\")"
    }
  },
  "required": [
    "name"
  ],
  "additionalProperties": false,
  "description": "Input schema for the get_integration tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Output schema

Output schema
{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Integration identifier"
    },
    "display_name": {
      "type": "string",
      "description": "Human-readable name"
    },
    "icon": {
      "type": [
        "string",
        "null"
      ],
      "description": "Icon filename (e.g., gmail.svg)"
    },
    "description": {
      "type": "string",
      "description": "Brief description of the integration"
    },
    "auth": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "description": "Authentication type: oauth2, oauth1, or api-key"
        },
        "provider": {
          "type": [
            "string",
            "null"
          ],
          "description": "OAuth provider name"
        },
        "scopes": {
          "anyOf": [
            {
              "type": "array",
              "items": {
                "type": "string",
                "description": "One scope item associated with this tool result."
              },
              "description": "List of scopes associated with this tool result."
            },
            {
              "type": "null",
              "description": "The scopes returned by the tool."
            }
          ],
          "description": "Required OAuth scopes"
        }
      },
      "required": [
        "type"
      ],
      "additionalProperties": false,
      "description": "Authentication configuration"
    },
    "env_vars": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "Environment variable name"
          },
          "description": {
            "type": "string",
            "description": "Description of the variable"
          },
          "required": {
            "type": "boolean",
            "description": "Whether this variable is required"
          },
          "sensitive": {
            "type": "boolean",
            "description": "Whether this variable contains sensitive data"
          }
        },
        "required": [
          "name",
          "description",
          "required",
          "sensitive"
        ],
        "additionalProperties": false,
        "description": "One env var item associated with this tool result."
      },
      "description": "Required environment variables"
    },
    "tools": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Tool identifier"
          },
          "name": {
            "type": "string",
            "description": "Tool name"
          },
          "description": {
            "type": "string",
            "description": "Tool description"
          }
        },
        "required": [
          "id",
          "name",
          "description"
        ],
        "additionalProperties": false,
        "description": "One tool item associated with this tool result."
      },
      "description": "Available tools provided by this integration"
    },
    "prompts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Prompt identifier"
          },
          "title": {
            "type": "string",
            "description": "Prompt title"
          },
          "prompt": {
            "type": "string",
            "description": "Prompt template text"
          }
        },
        "required": [
          "id",
          "title",
          "prompt"
        ],
        "additionalProperties": false,
        "description": "One prompt item associated with this tool result."
      },
      "description": "Available prompts provided by this integration"
    },
    "suggested_with": {
      "anyOf": [
        {
          "type": "array",
          "items": {
            "type": "string",
            "description": "One suggested with item associated with this tool result."
          },
          "description": "List of suggested with associated with this tool result."
        },
        {
          "type": "null",
          "description": "The suggested with returned by the tool."
        }
      ],
      "description": "Related integrations that work well with this one"
    }
  },
  "required": [
    "name",
    "display_name",
    "description",
    "auth",
    "env_vars",
    "tools",
    "prompts"
  ],
  "additionalProperties": false,
  "description": "Structured result returned by the get_integration tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}