Skip to main content
Glama

create_integration

Creates an AI-provider integration to act as the source for workspace providers, configuring backend credentials, hosts, tags, and pricing adjustments. Returns the new integration ID and slug.

Instructions

Create an AI-provider integration that becomes the source for workspace providers. ai_provider_id identifies the backend; provider-specific fields configure Azure, Bedrock, Vertex, or custom hosts. For workspace-scoped integrations, create_default_provider controls automatic provider creation. key is write-only, but secret_mappings can resolve it or configuration fields from Secret References at runtime. pricing_adjustments apply negotiated discounts or markups to cost accounting; tags attach key-value labels that list_integrations can filter on. Use update_integration_models and update_integration_workspaces after creation; returns the new integration id and slug.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "name": "<name>",
      "ai_provider_id": "<ai_provider_id>"
    },
    "name": "create_integration"
  }
}

Input Schema

NameRequiredDescriptionDefault
keyNoAPI key for the provider (if required)
nameYesHuman-readable name for the integration
slugNoURL-friendly identifier (auto-generated from name if not provided)
tagsNoIntegration tags, or null to create without tags
aws_regionNoAWS region (for AWS Bedrock)
api_versionNoAPI version (for Azure OpenAI)
custom_hostNoCustom base URL for the provider
descriptionNoOptional description of the integration
workspace_idNoWorkspace ID for workspace-scoped integrations
resource_nameNoResource name (for Azure OpenAI)
vertex_regionNoGCP region (for Vertex AI)
ai_provider_idYesID of the AI provider (e.g., 'openai', 'anthropic', 'azure-openai', 'aws-bedrock', 'vertex-ai')
deployment_nameNoDeployment name (for Azure OpenAI)
secret_mappingsNoUnique runtime Secret Reference mappings; mapping key allows the key field to be omitted
aws_access_key_idNoAWS access key ID (for AWS Bedrock)
vertex_project_idNoGCP project ID (for Vertex AI)
pricing_adjustmentsNoNegotiated discount or markup multipliers for cost accounting
aws_secret_access_keyNoAWS secret access key (for AWS Bedrock)
default_provider_slugNoCustom slug for the automatically created workspace provider
create_default_providerNoCreate a provider automatically for a workspace-scoped integration; defaults to true

Output Schema

NameRequiredDescriptionDefault
okYesCall succeeded
dataNoSuccess payload
errorNoFailure details

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changedv0.16.5
    • changedOutput schema / properties / data / description
      Previous value: -"Structured success payload when ok is true"New value: +"Success payload"
    • changedOutput schema / properties / error / description
      Previous value: -"Structured error payload when ok is false"New value: +"Failure details"
    • changedOutput schema / properties / error / properties / details / description
      Previous value: -"Optional structured error details"New value: +"Extra error details"
    • changedOutput schema / properties / error / properties / message / description
      Previous value: -"Human-readable error message"New value: +"Error message"
    • changedOutput schema / properties / ok / description
      Previous value: -"Whether the tool call succeeded and returned structured data"New value: +"Call succeeded"
  2. Changed2 schema fields changedv1.0.9
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
    • changedOutput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  3. Changed1 schema field changedv0.13.0
    • addedInput schema / properties / tags
      Added value: +{
      +  "anyOf": [
      +    {
      +      "additionalProperties": {
      +        "type": "string"
      +      },
      +      "propertyNames": {
      +        "type": "string"
      +      },
      +      "type": "object"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "description": "Integration tags, or null to create without tags"
      +}
  4. Changed2 schema fields changedv0.12.2
    • removedInput schema / properties / secret_mappings / items / properties / secret_key / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedInput schema / properties / secret_mappings / items / properties / secret_key / type
      Added value: +[
      +  "string",
      +  "null"
      +]
  5. Changed4 schema fields changed
    • addedInput schema / properties / create_default_provider
      Added value: +{
      +  "description": "Create a provider automatically for a workspace-scoped integration; defaults to true",
      +  "type": "boolean"
      +}
    • addedInput schema / properties / default_provider_slug
      Added value: +{
      +  "description": "Custom slug for the automatically created workspace provider",
      +  "maxLength": 255,
      +  "pattern": "^[a-zA-Z0-9_-]+$",
      +  "type": "string"
      +}
    • addedInput schema / properties / pricing_adjustments
      Added value: +{
      +  "anyOf": [
      +    {
      +      "properties": {
      +        "multiplier": {
      +          "description": "Per-unit multipliers applied over Portkey catalog pricing",
      +          "properties": {
      +            "additional_units": {
      +              "anyOf": [
      +                {
      +                  "additionalProperties": {
      +                    "anyOf": [
      +                      {
      +                        "minimum": 0,
      +                        "type": "number"
      +                      },
      +                      {
      +                        "type": "null"
      +                      }
      +                    ]
      +                  },
      +                  "propertyNames": {
      +                    "type": "string"
      +                  },
      +                  "type": "object"
      +                },
      +                {
      +                  "type": "null"
      +                }
      +              ],
      +              "description": "Multipliers keyed by Portkey pricing unit, such as web_search or file_search"
      +            },
      +            "cache_read_audio_input_token": {
      +              "anyOf": [
      +                {
      +                  "minimum": 0,
      +                  "type": "number"
      +                },
      +                {
      +                  "type": "null"
      +                }
      +              ],
      +              "description": "Cache-read audio input token price multiplier"
      +            },
      +            "cache_read_image_input_token": {
      +              "anyOf": [
      +                {
      +                  "minimum": 0,
      +                  "type": "number"
      +                },
      +                {
      +                  "type": "null"
      +                }
      +              ],
      +              "description": "Cache-read image input token price multiplier"
      +            },
      +            "cache_read_input_token": {
      +              "anyOf": [
      +                {
      +                  "minimum": 0,
      +                  "type": "number"
      +                },
      +                {
      +                  "type": "null"
      +                }
      +              ],
      +              "description": "Cache-read input token price multiplier"
      +            },
      +            "cache_read_text_input_token": {
      +              "anyOf": [
      +                {
      +                  "minimum": 0,
      +                  "type": "number"
      +                },
      +                {
      +                  "type": "null"
      +                }
      +              ],
      +              "description": "Cache-read text input token price multiplier"
      +            },
      +            "cache_write_image_input_token": {
      +              "anyOf": [
      +                {
      +                  "minimum": 0,
      +                  "type": "number"
      +                },
      +                {
      +                  "type": "null"
      +                }
      +              ],
      +              "description": "Cache-write image input token price multiplier"
      +            },
      +            "cache_write_input_token": {
      +              "anyOf": [
      +                {
      +                  "minimum": 0,
      +                  "type": "number"
      +                },
      +                {
      +                  "type": "null"
      +                }
      +              ],
      +              "description": "Cache-write input token price multiplier"
      +            },
      +            "cache_write_text_input_token": {
      +              "anyOf": [
      +                {
      +                  "minimum": 0,
      +                  "type": "number"
      +                },
      +                {
      +                  "type": "null"
      +                }
      +              ],
      +              "description": "Cache-write text input token price multiplier"
      +            },
      +            "default": {
      +              "anyOf": [
      +                {
      +                  "minimum": 0,
      +                  "type": "number"
      +                },
      +                {
      +                  "type": "null"
      +                }
      +              ],
      +              "description": "Fallback multiplier for pricing units; 1 is unchanged, 0.8 is a 20% discount"
      +            },
      +            "image": {
      +              "anyOf": [
      +                {
      +                  "properties": {
      +                    "default": {
      +                      "anyOf": [
      +                        {
      +                          "minimum": 0,
      +                          "type": "number"
      +                        },
      +                        {
      +                          "type": "null"
      +                        }
      +                      ],
      +                      "description": "Default image-generation price multiplier"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                {
      +                  "type": "null"
      +                }
      +              ],
      +              "description": "Image-generation pricing multipliers"
      +            },
      +            "prediction_accepted_token": {
      +              "anyOf": [
      +                {
      +                  "minimum": 0,
      +                  "type": "number"
      +                },
      +                {
      +                  "type": "null"
      +                }
      +              ],
      +              "description": "Accepted predicted-output token price multiplier"
      +            },
      +            "prediction_rejected_token": {
      +              "anyOf": [
      +                {
      +                  "minimum": 0,
      +                  "type": "number"
      +                },
      +                {
      +                  "type": "null"
      +                }
      +              ],
      +              "description": "Rejected predicted-output token price multiplier"
      +            },
      +            "reasoning_token": {
      +              "anyOf": [
      +                {
      +                  "minimum": 0,
      +                  "type": "number"
      +                },
      +                {
      +                  "type": "null"
      +                }
      +              ],
      +              "description": "Reasoning token price multiplier"
      +            },
      +            "request_audio_token": {
      +              "anyOf": [
      +                {
      +                  "minimum": 0,
      +                  "type": "number"
      +                },
      +                {
      +                  "type": "null"
      +                }
      +              ],
      +              "description": "Audio input token price multiplier"
      +            },
      +            "request_image_token": {
      +              "anyOf": [
      +                {
      +                  "minimum": 0,
      +                  "type": "number"
      +                },
      +                {
      +                  "type": "null"
      +                }
      +              ],
      +              "description": "Image input token price multiplier"
      +            },
      +            "request_text_token": {
      +              "anyOf": [
      +                {
      +                  "minimum": 0,
      +                  "type": "number"
      +                },
      +                {
      +                  "type": "null"
      +                }
      +              ],
      +              "description": "Text input token price multiplier"
      +            },
      +            "request_token": {
      +              "anyOf": [
      +                {
      +                  "minimum": 0,
      +                  "type": "number"
      +                },
      +                {
      +                  "type": "null"
      +                }
      +              ],
      +              "description": "Input token price multiplier"
      +            },
      +            "response_audio_token": {
      +              "anyOf": [
      +                {
      +                  "minimum": 0,
      +                  "type": "number"
      +                },
      +                {
      +                  "type": "null"
      +                }
      +              ],
      +              "description": "Audio output token price multiplier"
      +            },
      +            "response_image_token": {
      +              "anyOf": [
      +                {
      +                  "minimum": 0,
      +                  "type": "number"
      +                },
      +                {
      +                  "type": "null"
      +                }
      +              ],
      +              "description": "Image output token price multiplier"
      +            },
      +            "response_text_token": {
      +              "anyOf": [
      +                {
      +                  "minimum": 0,
      +                  "type": "number"
      +                },
      +                {
      +                  "type": "null"
      +                }
      +              ],
      +              "description": "Text output token price multiplier"
      +            },
      +            "response_token": {
      +              "anyOf": [
      +                {
      +                  "minimum": 0,
      +                  "type": "number"
      +                },
      +                {
      +                  "type": "null"
      +                }
      +              ],
      +              "description": "Output token price multiplier"
      +            }
      +          },
      +          "type": "object"
      +        }
      +      },
      +      "type": "object"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "description": "Negotiated discount or markup multipliers for cost accounting"
      +}
    • addedInput schema / properties / secret_mappings
      Added value: +{
      +  "description": "Unique runtime Secret Reference mappings; mapping key allows the key field to be omitted",
      +  "items": {
      +    "properties": {
      +      "secret_key": {
      +        "anyOf": [
      +          {
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ],
      +        "description": "Optional key to select from a multi-value secret"
      +      },
      +      "secret_reference_id": {
      +        "description": "Secret Reference UUID or slug accessible to the workspace",
      +        "type": "string"
      +      },
      +      "target_field": {
      +        "description": "Integration field populated at runtime: key or configurations.<field>",
      +        "type": "string"
      +      },
      +      "value_format": {
      +        "anyOf": [
      +          {
      +            "enum": [
      +              "string",
      +              "json"
      +            ],
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ],
      +        "description": "Treat the resolved value as a plain string or parsed JSON"
      +      }
      +    },
      +    "required": [
      +      "target_field",
      +      "secret_reference_id"
      +    ],
      +    "type": "object"
      +  },
      +  "type": "array"
      +}
  6. Addedv1.0.1
  7. Removed
  8. First observed

TDQS

A4.3/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare the safety profile (readOnlyHint=false, openWorldHint=true, destructiveHint=false, idempotentHint=false), so the bar is lower, yet the description still adds real behavior: 'key is write-only', secret_mappings resolving fields at runtime, pricing_adjustments affecting cost accounting, tags being filterable by list_integrations, and the create_default_provider default of true. It does not discuss error/conflict handling for duplicate slugs or permission requirements, which keeps it off a 5.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with identity and scope, then provider configuration, then secret handling, then cost/tags, then follow-up calls and the return value. Dense but nearly every sentence carries new information; it is on the long side for a description and could have split lifecycle guidance out, but there is little filler.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 20-parameter creation tool with an output schema, the description covers the non-obvious mechanics (write-only key, secret references, default provider creation, pricing multipliers, tag filtering) and gestures at the return value. Gaps are around failure modes and permission/auth requirements, which matter for an openWorldHint, non-idempotent create but are secondary given the rich schema.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 100% schema description coverage the baseline is 3, but the description adds grouping and meaning the schema alone does not: 'provider-specific fields configure Azure, Bedrock, Vertex, or custom hosts' tells the agent which parameters are mutually relevant, and it clarifies that 'key is write-only' and can be substituted via secret_mappings. Most of the 20 parameters are still only explained in-schema, so it exceeds but does not exhaust the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Opens with a specific verb and resource ('Create an AI-provider integration') and immediately states its downstream role ('becomes the source for workspace providers'), which cleanly separates it from create_mcp_integration and the update_* siblings. ai_provider_id is named as the backend selector, so the agent knows exactly what it is building.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives explicit lifecycle guidance ('Use update_integration_models and update_integration_workspaces after creation'), which is genuinely useful routing information. It stops short of naming when to prefer this over create_mcp_integration or create_provider, and offers no exclusion/precondition rules, so it is clear context rather than a full decision procedure.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools