Skip to main content
Glama

server_test_webhook

Test webhook functionality by sending a verification message to confirm proper setup and operation.

Instructions

Send a test message to verify a webhook is working

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
server_idYesServer ID or UUID
webhook_idYesWebhook ID to test

Implementation Reference

  • The implementation of the server_test_webhook tool, which uses the client to POST to the test endpoint of a webhook.
    server.tool(
      "server_test_webhook",
      "Send a test message to verify a webhook is working",
      {
        server_id: z.string().describe("Server ID or UUID"),
        webhook_id: z.string().describe("Webhook ID to test"),
      },
      async ({ server_id, webhook_id }) => {
        try {
          const data = await client.post(
            `/servers/${server_id}/webhooks/${webhook_id}/test`
          );
          return { content: [{ type: "text", text: JSON.stringify(data, null, 2) }] };
        } catch (error) {
          const msg = error instanceof Error ? error.message : String(error);
          return { content: [{ type: "text", text: `Error: ${msg}` }], isError: true };
        }
      }
    );
Behavior2/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It mentions sending a test message but doesn't specify what the test entails (e.g., a mock payload, response handling), potential side effects (e.g., triggering external systems), or authentication requirements. This leaves gaps in understanding the tool's behavior beyond its basic function.

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 a single, efficient sentence that directly states the tool's function without unnecessary words. It's front-loaded with the core action, making it easy to grasp quickly, and every part of the sentence contributes to understanding the purpose.

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?

Given the complexity of testing a webhook (which involves sending data and potentially receiving responses), the lack of annotations and output schema means the description should do more to explain behavioral aspects like what the test message contains or how success/failure is indicated. Currently, it's insufficient for a tool that interacts with external systems.

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?

The input schema has 100% description coverage, clearly documenting both parameters ('server_id' and 'webhook_id') as required IDs. The description adds no additional semantic context beyond implying these are needed to identify the webhook to test, so it meets the baseline for high schema coverage without compensating further.

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?

The description clearly states the action ('send a test message') and the resource ('to verify a webhook is working'), making the purpose specific and understandable. However, it doesn't explicitly differentiate from sibling tools like 'server_get_webhook' or 'server_update_webhook', which would require mentioning it's for testing functionality rather than retrieval or configuration.

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?

The description provides no guidance on when to use this tool versus alternatives, such as 'server_get_webhook' for checking webhook details or 'server_update_webhook' for modifying settings. It also lacks prerequisites, like needing an existing webhook, which could be inferred but isn't stated explicitly.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/HadiCherkaoui/crafty-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server