Skip to main content
Glama

x_api_validate_webhooks

Validate a webhook using its unique ID to verify configuration and authorization, ensuring it meets X API requirements before use.

Instructions

Validate webhook. Use when: Validate webhook. Do not use when: a more specific auth/configuration tool is required before the API call or you are only exploring; prefer x_schema_discovery or x_query_suggestion first. Risk: mutating, high-risk. Required permissions and prerequisites: bearer token; OAuth 1a user token Environment-selection behavior: scopeTenantId plus exactly one of scopeUserId or scopeAccountId choose the Vault/Postgres tenant principal used for auth resolution. credentialKey selects a non-default stored credential profile when present. Parameter formats and constraints: webhook_id (path, unknown, required). Expected response shape: { ok, status, data: { method, path, url, status, contentType, authType, data } } Common failure conditions: missing scoped credentials in Vault, missing required API parameters, X API auth failures, rate limits, or unsupported multipart/body shape. Recommended prerequisite and follow-up tools: x_connection_info, x_schema_discovery, x_auth_upsert_principal_credentials, x_api_request. Safety warnings: This mutates X state. Validate scope, payload, and authorizationKey before use. Example: {"name":"x_api_validate_webhooks","arguments":{"scopeTenantId":"default","scopeUserId":"default","webhook_id":""}}

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
webhook_idYes
scopeUserIdNo
credentialKeyNo
scopeTenantIdNo
scopeAccountIdNo
authorizationKeyNo
preferredAuthTypeNo
Behavior5/5

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

With no annotations, the description carries the full burden and does so thoroughly: it labels the risk as 'mutating, high-risk,' states that it mutates X state, lists required auth tokens, explains environment-selection behavior, and enumerates common failure conditions. This is exemplary transparency for a mutating tool.

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?

The description is well-structured with labeled sections (risk, permissions, environment, params, response, failures, prerequisites, safety, example), making dense information scannable. The redundant 'Use when: Validate webhook' adds little value and slightly undercuts conciseness.

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?

Given the lack of annotations and an output schema, the description is remarkably complete: it covers required permissions, environment selection, expected response shape, common failures, safety warnings, and provides a concrete example. This is sufficient for an agent to make a reasonably safe and informed invocation decision.

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 0%, so the description must compensate. It meaningfully explains scopeTenantId, scopeUserId, scopeAccountId, and credentialKey auth-scoping behavior, and tags webhook_id as a required path parameter. However, it never defines authorizationKey or preferredAuthType, leaving two of the seven parameters semantically underexplained.

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

Purpose2/5

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

The core description is a near-verbatim restatement of the tool name ('Validate webhook') with no elaboration on what validation actually does—whether it sends a test event, checks endpoint reachability, or returns configuration status. The expected response shape hints at an HTTP-style result, but the purpose statement itself is tautological and does not clearly distinguish the operation beyond the name.

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?

The description provides explicit 'Do not use when' guidance and names alternatives (x_schema_discovery, x_query_suggestion), plus a 'Recommended prerequisite and follow-up tools' section. However, the 'Use when' clause is circular ('Validate webhook') rather than describing a concrete scenario, which prevents a perfect score.

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/LesterAJohn/X-mcp'

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