Skip to main content
Glama

Webhooks Index

webhooks_index

Lists an organisation's webhooks with pagination and filter query support, enabling you to review configured webhook endpoints for that organisation.

Instructions

List organisation webhooks. GET /organisations/{organisationId}/webhooks

Pagination maps to page[number]/page[limit]; query keys (filter, q, include, fields[...]) pass through verbatim.

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": {
      "organisation_id": "<organisation_id>"
    },
    "name": "webhooks_index"
  }
}

Input Schema

NameRequiredDescriptionDefault
queryNo
page_limitNo
page_numberNo
organisation_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.3/5.0
Behavior3/5

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

No annotations are provided, so the description carries the full burden; it partially meets it by disclosing the HTTP verb/path (implying a read) and how pagination and query pass-through behave. It omits return shape, default page size, auth requirements, and rate limits, which are material for a list endpoint.

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?

Two short blocks, front-loaded with the purpose and followed by the operational detail; almost every phrase carries information. The raw endpoint path is slightly redundant with the stated purpose but adds concrete grounding.

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

Completeness3/5

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

With no annotations, no output schema, and four undocumented schema parameters, the description is only adequate: it explains pagination and query mechanics but says nothing about the response payload, default/maximum page sizes, or filtering syntax within query. An agent could call it, but would be guessing at result structure.

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?

Schema description coverage is 0%, so the description must compensate, and it does for three of four parameters: page_limit/page_number map to page[number] and page[limit], and query is described as pass-through with example keys (filter, q, include, fields[...]). organisation_id is left implicit but is self-explanatory from the resource name.

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

Purpose4/5

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

"List organisation webhooks" gives a specific verb and resource, and the accompanying GET path confirms it is a scoped read of webhooks for one organisation. That distinguishes it from webhooks_show / webhooks_create / webhooks_destroy by action, though the description never explicitly names those siblings.

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 explicit when-to-use or when-not-to-use guidance, and no statement of prerequisites such as authentication or required permissions. The agent must infer from the name that this is the collection-listing call and that webhooks_show is the single-record alternative.

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