Skip to main content
Glama

webhooks_create_instance

Create an App Store Connect webhook for event notifications by sending a POST request with a JSON:API WebhookCreateRequest body.

Instructions

POST /v1/webhooks (POST /v1/webhooks) Body shape: see OpenAPI components.schemas.WebhookCreateRequest for the full JSON:API envelope.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
bodyYesJSON body. Shape: components.schemas.WebhookCreateRequest.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.5.0

TDQS

C2.5/5.0
Behavior2/5

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

With no annotations, the description carries the full behavioral burden and discloses almost nothing: no auth requirements, no side effects, no idempotency or rate-limit notes, no indication of what is returned. The only concrete hint is that the body follows the WebhookCreateRequest OpenAPI schema.

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

Conciseness3/5

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

It is short and front-loaded, but wastes tokens by duplicating the endpoint in parentheses ('POST /v1/webhooks (POST /v1/webhooks)'), which reads as a generation artifact rather than useful information.

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

Completeness2/5

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

For a mutation tool with no annotations, no output schema, and a nested free-form body object, the description punts entirely to an external OpenAPI spec. An agent cannot determine what creating a webhook entails or what a valid body contains from this definition alone.

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?

There is a single 'body' parameter and schema description coverage is 100%, so the baseline is 3. The description adds a marginal pointer to components.schemas.WebhookCreateRequest for the full JSON:API envelope, but no field-level meaning beyond the schema.

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

Purpose3/5

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

The description 'POST /v1/webhooks' conveys the operation only through REST convention: POST on the webhooks collection means create. An agent must infer 'creates a webhook' rather than being told directly, and nothing distinguishes it from siblings like webhooks_update_instance or marketplace_webhooks_create_instance.

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

Usage Guidelines2/5

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

There is no guidance on when to use this tool versus alternatives such as webhooks_update_instance or webhook_pings_create_instance, and no stated prerequisites. The REST endpoint is given but no contextual routing is provided.

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