Skip to main content
Glama

create_integration

Add an integration: a URL on the workspace's own server that Help will ask about customers. The answer includes its secret, shown this once: put it in that server's configuration now (never in a page or a repository), then build the URL to check Help's signature with it and call test_integration. Owner only.

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": {
      "product_id": "<product_id>",
      "name": "<name>",
      "url": "<url>"
    },
    "name": "create_integration"
  }
}

Input Schema

NameRequiredDescriptionDefault
urlYesThe address on the workspace's own server that Help will send signed requests to. It must start with https://.
nameYesIts name, like "Accounts". The team sees it above the side panel.
product_idYesThe site it is for (a uuid from list_products).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.5/5.0
Behavior5/5

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

Beyond the annotations, it discloses critical behavior: the answer includes a secret shown only once, the secret must go into server configuration rather than a page or repository, and the caller is restricted to the owner. These are exactly the kind of post-conditions and security constraints an agent needs for a mutation tool.

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

Conciseness5/5

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

The description is dense and front-loaded: it defines the resource first, then the returned secret and handling instructions, then the next-step validation and permission constraint. Every clause carries operational value.

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

Completeness5/5

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

For a create/mutation tool with three required parameters and no output schema, the description covers what is created, the one-time secret in the response, secure handling, owner-only access, and the follow-up test_integration call. An agent has enough context to invoke it correctly without additional documentation.

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

Parameters3/5

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

Schema description coverage is 100%, so all three parameters are already documented in the input schema. The description reinforces that the URL belongs on the workspace's own server, but it does not add syntax, format, or validation details beyond what the schema provides.

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?

The description states a specific verb ('Add') and resource ('an integration'), then defines the resource as a URL on the workspace's own server that Help will query about customers. This clearly distinguishes it from siblings such as update_integration, remove_integration, and add_integration_address.

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?

It gives clear operational context: owner-only authorization, what to do with the returned secret immediately, and the next step of building a signature check and calling test_integration. It does not explicitly name update_integration or other alternatives, but the creation workflow is well specified.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources