Skip to main content
Glama
optimize-overseas

lob-mcp

by optimize-overseas
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

List webhooks

lob_webhooks_list
Read-onlyIdempotent

List webhook subscriptions on your account, with optional date and metadata filters, and paginate results using before/after cursors.

Instructions

List webhook subscriptions on your account. Note: Lob's /webhooks does NOT support include: ['total_count'] — for a count, just inspect data.length (webhook lists are small).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
afterNoCursor for the next page.
limitNoHow many results to return (default 10, max 100).
beforeNoCursor for the previous page.
includeNoResponse add-ons. Pass ['total_count'] alongside any filters and limit:1 to answer 'how many?' questions in a single call — far cheaper than paginating to count. Not accepted on nested order endpoints (buckslip/card orders) or /webhooks.
metadataNoFilter by metadata key/value pairs.
date_createdNoISO8601 date filter object with gt/gte/lt/lte keys, e.g. { gt: '2026-04-23T00:00:00Z' } for 'last 7 days'. Combine with include:['total_count'] and limit:1 for date-bounded counts.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.3.0

TDQS

A4.4/5.0
Behavior5/5

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

Annotations already mark the tool as read-only, non-destructive, and idempotent. The description adds that webhook lists are small and that the 'total_count' parameter is not supported, disclosing non-obvious API limitations beyond the 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 concise sentences: the first states the purpose, the second provides a critical caveat. No unnecessary words, and the key information is front-loaded.

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?

The description, combined with annotations and schema, gives sufficient context for a simple list tool. It lacks explicit mention of the return format (e.g., a list of webhook objects), but the agent can infer from the tool's purpose and parameters.

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?

Input schema has 100% coverage with detailed descriptions for all 6 parameters. The description's note about 'total_count' is already present in the schema's explanation of the 'include' parameter, so it adds no new parameter-level information. 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?

The description clearly states 'List webhook subscriptions on your account,' using a specific verb and resource. This distinguishes it from sibling tools like lob_webhooks_get or lob_webhooks_create, which have different purposes.

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 explicitly warns that 'include: ["total_count"]' is not supported and advises using 'data.length' instead. This gives clear when-to-use guidance for a common parameter, though it doesn't compare directly to siblings like list vs. get.

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