Skip to main content
Glama
PaddleHQ

Paddle MCP Server

Official
by PaddleHQ

get_notification

Read-only

Retrieve a Paddle notification by its ID to check delivery status, debug issues, and view event details for up to 90 days.

Instructions

This tool will retrieve a notification from Paddle by its ID.

When an event that has a notification destination occurs, Paddle creates a notification entity with information about the notification.

Notifications older than 90 days aren't retained. If trying to get a notification that's no longer retained, Paddle returns an error.

Check the following details to understand the success or failure of the notification according to Paddle and debug issues:

  • status: Status of the notification.

    • notAttempted: Paddle hasn't yet tried to deliver this notification.

    • needsRetry: Paddle tried to deliver this notification, but it failed. It's scheduled to be retried.

    • delivered: Paddle delivered this notification successfully.

    • failed: Paddle tried to deliver this notification, but all attempts failed. It's not scheduled to be retried.

  • origin: Describes how this notification was created.

    • event: Notification created when a subscribed event occurred.

    • replay: Notification created when a notification with the origin event was replayed.

  • deliveredAt: RFC 3339 datetime string of when this notification was delivered. null if not yet delivered successfully.

  • lastAttemptAt: RFC 3339 datetime string of when this notification was last attempted.

  • retryAt: RFC 3339 datetime string of when this notification is scheduled to be retried.

  • timesAttempted: How many times delivery of this notification has been attempted.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
notificationIdYesPaddle ID of the notification.

Implementation Reference

  • The handler function that executes the get_notification tool. It takes a notificationId parameter and retrieves the notification using the Paddle SDK's notifications.get method.
    export const getNotification = async (paddle: Paddle, params: z.infer<typeof Parameters.getNotificationParameters>) => {
      try {
        const { notificationId } = params;
        const notification = await paddle.notifications.get(notificationId);
        return notification;
      } catch (error) {
        return error;
      }
    };
  • The tool schema definition, including method name, description from prompts, input parameters schema, and required actions/permissions.
    method: "get_notification",
    name: "Get a notification",
    description: prompts.getNotificationPrompt,
    parameters: params.getNotificationParameters,
    actions: {
      notifications: {
        read: true,
        get: true,
      },
    },
  • src/api.ts:52-52 (registration)
    Registration of the tool handler in the API's toolMap, mapping the constant TOOL_METHODS.GET_NOTIFICATION to the getNotification function.
    [TOOL_METHODS.GET_NOTIFICATION]: funcs.getNotification,
  • src/constants.ts:44-44 (registration)
    Constant definition for the tool method string 'get_notification'.
    GET_NOTIFICATION: "get_notification",
Behavior4/5

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

Annotations provide readOnlyHint=true, indicating a safe read operation. The description adds valuable behavioral context beyond this: it explains the 90-day retention policy, error handling for non-retained notifications, and details about notification statuses and attributes (e.g., status, origin, timestamps). This enhances understanding of the tool's behavior without contradicting annotations.

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 and front-loaded with the core purpose, followed by important behavioral details. It avoids unnecessary fluff, but the detailed breakdown of notification attributes (status, origin, etc.) is somewhat lengthy for a retrieval tool, though informative. Most sentences earn their place by clarifying tool behavior.

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?

For a read-only tool with one parameter and no output schema, the description is quite complete. It covers the tool's purpose, retention policy, error conditions, and key return attributes. However, it doesn't specify the output format or structure, which could be helpful given the lack of an output schema, leaving a minor gap.

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, with the 'notificationId' parameter clearly documented. The description doesn't add any parameter-specific information beyond what the schema provides, such as format examples or constraints. Given the high schema coverage, a baseline score of 3 is appropriate.

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 tool's purpose: 'retrieve a notification from Paddle by its ID.' This specifies the verb ('retrieve') and resource ('notification'), making it unambiguous. However, it doesn't explicitly differentiate from sibling tools like 'list_notifications' or 'get_notification_setting,' which would be needed for a perfect score.

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

Usage Guidelines3/5

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

The description implies usage by mentioning that notifications older than 90 days aren't retained, suggesting this tool is for retrieving specific, recent notifications. However, it lacks explicit guidance on when to use this versus alternatives like 'list_notifications' or 'replay_notification,' and doesn't mention prerequisites or exclusions.

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/PaddleHQ/paddle-mcp-server'

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