Skip to main content
Glama

create_soap_message

Create a new outbound SOAP Message definition in sys_soap_message (requires WRITE_ENABLED=true). The endpoint URL is set per function via create_soap_message_function.

Instructions

Create a new outbound SOAP Message definition in sys_soap_message (requires WRITE_ENABLED=true). The endpoint URL is set per function via create_soap_message_function.

Input Schema

NameRequiredDescriptionDefault
nameYesUnique SOAP Message name
wsdlNoWSDL URL for the service (used for schema introspection)
descriptionNoPurpose/description of this integration
authentication_typeNoAuth type: "no_authentication" (default), "basic", "mutual_authentication"

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changedv1.15.1
    • removedInput schema / properties / active
      Removed value: -{
      -  "description": "Make active immediately (default: true)",
      -  "type": "boolean"
      -}
    • removedInput schema / properties / endpoint
      Removed value: -{
      -  "description": "SOAP service endpoint URL",
      -  "type": "string"
      -}
    • removedInput schema / properties / namespace
      Removed value: -{
      -  "description": "XML namespace for SOAP body elements",
      -  "type": "string"
      -}
    • removedInput schema / properties / soap_action_prefix
      Removed value: -{
      -  "description": "Prefix prepended to all SOAP action headers",
      -  "type": "string"
      -}
    • changedInput schema / required
      Previous value: -[
      -  "name",
      -  "endpoint"
      -]New value: +[
      +  "name"
      +]
  2. First observedv1.0.2

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=false, destructiveHint=false, idempotentHint=false and openWorldHint=true, so the mutation profile is known. The description adds meaningful operational context: the WRITE_ENABLED=true gate and the fact that endpoint URLs are not configured here, which the agent could not infer from annotations.

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?

Two compact sentences, front-loaded with the action and table, followed by the gating requirement and the sibling boundary. No padding.

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 create mutation with no output schema and fully documented parameters, the description covers the important facts: target table, write gate, and where endpoint configuration lives. It could mention whether name must be unique at creation time or what is returned, but nothing essential to correct invocation is missing.

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%, with each of the four parameters documented (including auth type values), so the schema does the heavy lifting. The description adds only the wsdl/endpoint-related nuance, so baseline 3 applies.

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?

States a specific verb and resource ('Create a new outbound SOAP Message definition') and names the target table sys_soap_message, which cleanly distinguishes it from create_soap_message_function and create_rest_message.

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 an explicit precondition (requires WRITE_ENABLED=true) and clarifies the division of labor with create_soap_message_function for endpoint URLs. It stops short of naming alternatives for listing/inspecting existing messages, but the usage context is clear.

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