@metronome/mcp 1.0.0 → 2.1.0

package/README.md

@@ -283,9 +283,9 @@ The following tools are available in this MCP server.
 
 ### Resource `v1.alerts`:
 
-- `create_v1_alerts` (`write`): Create a new alert to monitor customer spending, balances, and billing metrics in real-time. Metronome's alert system provides industry-leading speed with immediate evaluation capabilities, enabling you to proactively manage customer accounts and prevent revenue leakage.
+- `create_v1_alerts` (`write`): Create a new threshold notification to monitor customer spending, balances, and billing metrics in real-time. Metronome's notification system provides industry-leading speed with immediate evaluation capabilities, enabling you to proactively manage customer accounts and prevent revenue leakage.
 
-  This endpoint creates configurable alerts that continuously monitor various billing thresholds including spend limits, credit balances, commitment utilization, and invoice totals. Alerts can be configured globally for all customers or targeted to specific customer accounts. Custom fields can be used on certain alert types to further target alerts to groups of customers.
+  This endpoint creates configurable threshold notifications that continuously monitor various billing thresholds including spend limits, credit balances, commitment utilization, and invoice totals. Threshold notifications can be configured globally for all customers or targeted to specific customer accounts.
 
   ### Use this endpoint to:
 
@@ -298,55 +298,53 @@ The following tools are available in this MCP server.
 
   A successful response returns a CustomerAlert object containing:
 
-  - The alert configuration with its unique ID and current status
+  - The threshold notification configuration with its unique ID and current status
   - The customer's evaluation status (ok, in_alarm, or evaluating)
-  - Alert metadata including type, threshold values, and update timestamps
+  - Threshold notification metadata including type, threshold values, and update timestamps
 
   ### Usage guidelines:
 
   - Immediate evaluation: Set `evaluate_on_create` : `true` (default) for instant evaluation against existing customers
-  - Uniqueness constraints: Each alert must have a unique `uniqueness_key` within your organization. Use `release_uniqueness_key` : `true` when archiving to reuse keys
-  - Alert type requirements: Different alert types require specific fields (e.g., `billable_metric_id` for usage alerts, `credit_type_id` for credit-based alerts)
-  - Webhook delivery: Alerts trigger webhook notifications for real-time integration with your systems. Configure webhook endpoints before creating alerts
-  - Performance at scale: Metronome's event-driven architecture processes alert evaluations in real-time as usage events stream in, unlike competitors who rely on periodic polling or batch evaluation cycles
+  - Uniqueness constraints: Each threshold notification must have a unique `uniqueness_key` within your organization. Use `release_uniqueness_key` : `true` when archiving to reuse keys
+  - Notification type requirements: Different threshold notification types require specific fields (e.g., `billable_metric_id` for usage notifications, `credit_type_id` for credit-based threshold notifications)
+  - Webhook delivery: Threshold notifications trigger webhook notifications for real-time integration with your systems. Configure webhook endpoints before creating threshold notifications
+  - Performance at scale: Metronome's event-driven architecture processes threshold notification evaluations in real-time as usage events stream in, unlike competitors who rely on periodic polling or batch evaluation cycles
 
-- `archive_v1_alerts` (`write`): Permanently disable an alert and remove it from active monitoring across all customers. Archived alerts stop evaluating immediately and can optionally release their uniqueness key for reuse in future alert configurations.
+- `archive_v1_alerts` (`write`): Permanently disable a threshold notification and remove it from active monitoring across all customers. Archived threshold notifications stop evaluating immediately and can optionally release their uniqueness key for reuse in future threshold notification configurations.
 
   ### Use this endpoint to:
 
-  - Decommission alerts that are no longer needed
-  - Clean up test or deprecated alert configurations
-  - Free up uniqueness keys for reuse with new alerts
-  - Stop alert evaluations without losing historical configuration data
+  - Decommission threshold notifications that are no longer needed
+  - Clean up test or deprecated threshold notification configurations
+  - Free up uniqueness keys for reuse with new threshold notifications
+  - Stop threshold notification evaluations without losing historical configuration data
   - Disable outdated monitoring rules during pricing model transitions
 
   ### Key response fields:
 
-  - data: Object containing the archived alert's ID
-  - Alert evaluation stops immediately for all affected customers
-  - Historical alert data and configurations remain accessible for audit purposes
+  - data: Object containing the archived threshold notification's ID
 
   ### Usage guidelines:
 
-  - Irreversible for evaluation: Archived alerts cannot be re-enabled; create a new alert to resume monitoring
-  - Uniqueness key handling: Set `release_uniqueness_key` : `true` to reuse the key in future alerts
-  - Immediate effect: Alert evaluation stops instantly across all customers
-  - Historical preservation: Archive operation maintains alert history and configuration for compliance and auditing
+  - Irreversible for evaluation: Archived threshold notifications cannot be re-enabled; create a new threshold notification to resume monitoring
+  - Uniqueness key handling: Set `release_uniqueness_key` : `true` to reuse the key in future threshold notifications
+  - Immediate effect: Threshold notification evaluation stops instantly across all customers
+  - Historical preservation: Archive operation maintains threshold notification history and configuration for compliance and auditing
 
 ### Resource `v1.plans`:
 
-- `list_v1_plans` (`read`): List all available plans.
-- `get_details_v1_plans` (`read`): Fetch high level details of a specific plan.
-- `list_charges_v1_plans` (`read`): Fetches a list of charges of a specific plan.
-- `list_customers_v1_plans` (`read`): Fetches a list of customers on a specific plan (by default, only currently active plans are included)
+- `list_v1_plans` (`read`): List all available plans. This is a Plans (deprecated) endpoint. New clients should implement using Contracts.
+- `get_details_v1_plans` (`read`): Fetch high level details of a specific plan. This is a Plans (deprecated) endpoint. New clients should implement using Contracts.
+- `list_charges_v1_plans` (`read`): Fetches a list of charges of a specific plan. This is a Plans (deprecated) endpoint. New clients should implement using Contracts.
+- `list_customers_v1_plans` (`read`): Fetches a list of customers on a specific plan (by default, only currently active plans are included). This is a Plans (deprecated) endpoint. New clients should implement using Contracts.
 
 ### Resource `v1.credit_grants`:
 
-- `create_v1_credit_grants` (`write`): Create a new credit grant
-- `list_v1_credit_grants` (`write`): List credit grants. This list does not included voided grants.
-- `edit_v1_credit_grants` (`write`): Edit an existing credit grant
-- `list_entries_v1_credit_grants` (`write`): Fetches a list of credit ledger entries. Returns lists of ledgers per customer. Ledger entries are returned in chronological order. Ledger entries associated with voided credit grants are not included.
-- `void_v1_credit_grants` (`write`): Void a credit grant
+- `create_v1_credit_grants` (`write`): Create a new credit grant. This is a Plans (deprecated) endpoint. New clients should implement using Contracts.
+- `list_v1_credit_grants` (`write`): List credit grants. This list does not included voided grants. This is a Plans (deprecated) endpoint. New clients should implement using Contracts.
+- `edit_v1_credit_grants` (`write`): Edit an existing credit grant. This is a Plans (deprecated) endpoint. New clients should implement using Contracts.
+- `list_entries_v1_credit_grants` (`write`): Fetches a list of credit ledger entries. Returns lists of ledgers per customer. Ledger entries are returned in chronological order. Ledger entries associated with voided credit grants are not included. This is a Plans (deprecated) endpoint. New clients should implement using Contracts.
+- `void_v1_credit_grants` (`write`): Void a credit grant. This is a Plans (deprecated) endpoint. New clients should implement using Contracts.
 
 ### Resource `v1.pricing_units`:
 
@@ -388,11 +386,11 @@ The following tools are available in this MCP server.
   - Once a customer is archived, it cannot be unarchived.
   - Archived customers can still be viewed through the API or the UI for audit purposes.
   - Ingest aliases remain idempotent for archived customers. In order to reuse an ingest alias, first remove the ingest alias from the customer prior to archiving.
-  - Any alerts associated with the customer will no longer be triggered.
+  - Any notifications associated with the customer will no longer be triggered.
 
 - `list_billable_metrics_v1_customers` (`read`): Get all billable metrics available for a specific customer. Supports pagination and filtering by current plan status or archived metrics. Use this endpoint to see which metrics are being tracked for billing calculations for a given customer.
-- `list_costs_v1_customers` (`read`): Fetch daily pending costs for the specified customer, broken down by credit type and line items. Note: this is not supported for customers whose plan includes a UNIQUE-type billable metric.
-- `preview_events_v1_customers` (`write`): Preview how a set of events will affect a customer's invoice. Generates a draft invoice for a customer using their current contract configuration and the provided events. This is useful for testing how new events will affect the customer's invoice before they are actually processed.
+- `list_costs_v1_customers` (`read`): Fetch daily pending costs for the specified customer, broken down by credit type and line items. Note: this is not supported for customers whose plan includes a UNIQUE-type billable metric. This is a Plans (deprecated) endpoint. New clients should implement using Contracts.
+- `preview_events_v1_customers` (`write`): Preview how a set of events will affect a customer's invoices. Generates draft invoices for a customer using their current contract configuration and the provided events. This is useful for testing how new events will affect the customer's invoices before they are actually processed. Customers on contracts with SQL billable metrics are not supported.
 - `retrieve_billing_configurations_v1_customers` (`write`): Returns all billing configurations previously set for the customer. Use during the contract provisioning process to fetch the `billing_provider_configuration_id` needed to set the contract billing configuration.
 - `set_billing_configurations_v1_customers` (`write`): Create a billing configuration for a customer. Once created, these configurations are available to associate to a contract and dictates which downstream system to collect payment in or send the invoice to. You can create multiple configurations per customer. The configuration formats are distinct for each downstream provider.
 
@@ -400,6 +398,7 @@ The following tools are available in this MCP server.
 
   - Add the initial configuration to an existing customer. Once created, the billing configuration can then be associated to the customer's contract.
   - Add a new configuration to an existing customer. This might be used as part of an upgrade or downgrade workflow where the customer was previously billed through system A (e.g. Stripe) but will now be billed through system B (e.g. AWS). Once created, the new configuration can then be associated to the customer's contract.
+  - Multiple configurations can be added per destination. For example, you can create two Stripe billing configurations for a Metronome customer that each have a distinct `collection_method`.
 
   ### Delivery method options:
 
@@ -429,13 +428,16 @@ The following tools are available in this MCP server.
 
 ### Resource `v1.customers.alerts`:
 
-- `retrieve_customers_v1_alerts` (`write`): Retrieve the real-time evaluation status for a specific alert-customer pair. This endpoint provides instant visibility into whether a customer has triggered an alert condition, enabling you to monitor account health and take proactive action based on current alert states.
+- `retrieve_customers_v1_alerts` (`write`): Retrieve the real-time evaluation status for a specific threshold notification-customer pair. This endpoint provides instant visibility into whether a customer has triggered a threshold notification condition, enabling you to monitor account health and take proactive action based on current threshold notification states.
 
   ### Use this endpoint to:
 
-  - Check if a specific customer is currently violating an alert threshold (`in_alarm` status)
-  - Verify alert configuration details and threshold values for a customer
-  - Integrate alert status checks into customer support tools or admin interfaces
+  - Check if a specific customer is currently violating an threshold notification (`in_alarm` status)
+  - Verify threshold notification configuration details and threshold values for a customer
+  - Monitor the evaluation state of newly created or recently modified threshold notification
+  - Build dashboards or automated workflows that respond to specific threshold notification conditions
+  - Validate threshold notification behavior before deploying to production customers
+  - Integrate threshold notification status checks into customer support tools or admin interfaces
 
   ### Key response fields:
 
@@ -444,59 +446,63 @@ The following tools are available in this MCP server.
   - `customer_status`: The current evaluation state
 
   - `ok` - Customer is within acceptable thresholds
-  - `in_alarm`- Customer has breached the alert threshold
-  - `evaluating` - Alert has yet to be evaluated (typically due to a customer or alert having just been created)
-  - `null` - Alert has been archived
-  - `triggered_by`: Additional context about what caused the alert to trigger (when applicable)
-  - alert: Complete alert configuration including:
-    - Alert ID, name, and type
+  - `in_alarm` - Customer has breached the threshold for the notification
+  - `evaluating` - Notification is currently being evaluated (typically during initial setup)
+  - `null` - Notification has been archived
+  - `triggered_by`: Additional context about what caused the notification to trigger (when applicable)
+  - alert: Complete threshold notification configuration including:
+    - Notification ID, name, and type
     - Current threshold values and credit type information
-    - Alert status (enabled, disabled, or archived)
+    - Notification status (enabled, disabled, or archived)
     - Last update timestamp
     - Any applied filters (credit grant types, custom fields, group values)
 
   ### Usage guidelines:
 
-  - Customer status: Returns the current evaluation state, not historical data. For alert history, use webhook notifications or event logs
-  - Archived alerts: Returns null for customer_status if the alert has been archived, but still includes the alert configuration details
-  - Integration patterns: This endpoint can be used to check a customer's alert status, but shouldn't be scraped. You should instead rely on the webhook notification to understand when customers are moved to IN_ALARM.
-  - Error handling: Returns 404 if either the customer or alert ID doesn't exist or isn't accessible to your organization
+  - Customer status: Returns the current evaluation state, not historical data. For threshold notification history, use webhook notifications or event logs
+  - Required parameters: Both customer_id and alert_id must be valid UUIDs that exist in your organization
+  - Archived notifications: Returns null for customer_status if the notification has been archived, but still includes the notification configuration details
+  - Performance considerations: This endpoint queries live evaluation state, making it ideal for real-time monitoring but not for bulk status checks
+  - Integration patterns: Best used for on-demand status checks in response to user actions or as part of targeted monitoring workflows
+  - Error handling: Returns 404 if either the customer or alert_id doesn't exist or isn't accessible to your organization
 
-- `list_customers_v1_alerts` (`write`): Retrieve all alert configurations and their current statuses for a specific customer in a single API call. This endpoint provides a comprehensive view of all alerts monitoring a customer account.
+- `list_customers_v1_alerts` (`write`): Retrieve all threshold notification configurations and their current statuses for a specific customer in a single API call. This endpoint provides a comprehensive view of all threshold notification monitoring a customer account.
 
   ### Use this endpoint to:
 
-  - Display all active alerts for a customer in dashboards or admin panels
-  - Quickly identify which alerts a customer is currently triggering
-  - Audit alert coverage for specific accounts
-  - Filter alerts by status (enabled, disabled, or archived)
+  - Display all active threshold notifications for a customer in dashboards or admin panels
+  - Quickly identify which threshold notifications a customer is currently triggering
+  - Audit threshold notification coverage for specific accounts
+  - Filter threshold notifications by status (enabled, disabled, or archived)
 
   ### Key response fields:
 
   - data: Array of CustomerAlert objects, each containing:
     - Current evaluation status (`ok`, `in_alarm`, `evaluating`, or `null`)
-    - Complete alert configuration and threshold details
-    - Alert metadata including type, name, and last update time
-  - `next_page`: Pagination cursor for retrieving additional results
+    - Complete threshold notification configuration and threshold details
+    - Threshold notification metadata including type, name, and last update time
+  - next_page: Pagination cursor for retrieving additional results
 
   ### Usage guidelines:
 
-  - Default behavior: Returns only enabled alerts unless alert_statuses filter is specified
-  - Pagination: Use the `next_page` cursor to retrieve all results for customers with many alerts
+  - Default behavior: Returns only enabled threshold notifications unless `alert_statuses` filter is specified
+  - Pagination: Use the `next_page` cursor to retrieve all results for customers with many notifications
+  - Performance: Efficiently retrieves multiple threshold notification statuses in a single request instead of making individual calls
+  - Filtering: Pass the `alert_statuses` array to include disabled or archived threshold notifications in results
 
-- `reset_customers_v1_alerts` (`write`): Force an immediate re-evaluation of a specific alert for a customer, clearing any previous state and triggering a fresh assessment against current thresholds. This endpoint ensures alert accuracy after configuration changes or data corrections.
+- `reset_customers_v1_alerts` (`write`): Force an immediate re-evaluation of a specific threshold notification for a customer, clearing any previous state and triggering a fresh assessment against current thresholds. This endpoint ensures threshold notification accuracy after configuration changes or data corrections.
 
   ### Use this endpoint to:
 
-  - Clear false positive alerts after fixing data issues
-  - Re-evaluate alerts after adjusting customer balances or credits
-  - Test alert behavior during development and debugging
-  - Resolve stuck alerts that may be in an incorrect state
+  - Clear false positive threshold notifications after fixing data issues
+  - Re-evaluate threshold notifications after adjusting customer balances or credits
+  - Test threshold notification behavior during development and debugging
+  - Resolve stuck threshold notification that may be in an incorrect state
   - Trigger immediate evaluation after threshold modifications
 
   ### Key response fields:
 
-  - 200 Success: Confirmation that the alert has been reset and re-evaluation initiated
+  - 200 Success: Confirmation that the threshold notification has been reset and re-evaluation initiated
   - No response body is returned - the operation completes asynchronously
 
   ### Usage guidelines:
@@ -508,10 +514,10 @@ The following tools are available in this MCP server.
 
 ### Resource `v1.customers.plans`:
 
-- `list_customers_v1_plans` (`read`): List the given customer's plans in reverse-chronological order.
-- `add_customers_v1_plans` (`write`): Associate an existing customer with a plan for a specified date range. See the [price adjustments documentation](https://plans-docs.metronome.com/pricing/managing-plans/#price-adjustments) for details on the price adjustments.
-- `end_customers_v1_plans` (`write`): Change the end date of a customer's plan.
-- `list_price_adjustments_customers_v1_plans` (`read`): Lists a customer plans adjustments. See the [price adjustments documentation](https://plans-docs.metronome.com/pricing/managing-plans/#price-adjustments) for details.
+- `list_customers_v1_plans` (`read`): List the given customer's plans in reverse-chronological order. This is a Plans (deprecated) endpoint. New clients should implement using Contracts.
+- `add_customers_v1_plans` (`write`): Associate an existing customer with a plan for a specified date range. See the [price adjustments documentation](https://plans-docs.metronome.com/pricing/managing-plans/#price-adjustments) for details on the price adjustments. This is a Plans (deprecated) endpoint. New clients should implement using Contracts.
+- `end_customers_v1_plans` (`write`): Change the end date of a customer's plan. This is a Plans (deprecated) endpoint. New clients should implement using Contracts.
+- `list_price_adjustments_customers_v1_plans` (`read`): Lists a customer plans adjustments. See the [price adjustments documentation](https://plans-docs.metronome.com/pricing/managing-plans/#price-adjustments) for details. This is a Plans (deprecated) endpoint. New clients should implement using Contracts.
 
 ### Resource `v1.customers.invoices`:
 
@@ -580,7 +586,7 @@ The following tools are available in this MCP server.
     External billing provider statuses (like Stripe payment status) are included when applicable
   - Voided invoices are included in results by default unless filtered out by status
 
-- `add_charge_customers_v1_invoices` (`write`): Add a one time charge to the specified invoice
+- `add_charge_customers_v1_invoices` (`write`): Add a one time charge to the specified invoice. This is a Plans (deprecated) endpoint. New clients should implement using Contracts.
 - `list_breakdowns_customers_v1_invoices` (`read`): Retrieve granular time-series breakdowns of invoice data at hourly or daily intervals. This endpoint transforms standard invoices into detailed timelines, enabling you to track usage patterns, identify consumption spikes, and provide customers with transparency into their billing details throughout the billing period.
 
   ### Use this endpoint to:
@@ -610,11 +616,32 @@ The following tools are available in this MCP server.
   - Backdated usage: If usage events arrive after invoice finalization, breakdowns will reflect the updated usage
   - Zero quantity filtering: Use `skip_zero_qty_line_items=true` to exclude periods with no usage
 
+- `retrieve_pdf_customers_v1_invoices` (`read`): Retrieve a PDF version of a specific invoice by its unique identifier. This endpoint generates a professionally formatted invoice document suitable for sharing with customers, accounting teams, or for record-keeping purposes.
+
+  ### Use this endpoint to:
+
+  - Provide customers with downloadable or emailable copies of their invoices
+  - Support accounting and finance teams with official billing documents
+  - Maintain accurate records of billing transactions for audits and compliance
+
+  ### Key response details:
+
+  - The response is a binary PDF file representing the full invoice
+  - The PDF includes all standard invoice information such as line items, totals, billing period, and customer details
+  - The document is formatted for clarity and professionalism, suitable for official use
+
+  ### Usage guidelines:
+
+  - Ensure the `invoice_id` corresponds to an existing invoice for the specified `customer_id`
+  - The PDF is generated on-demand; frequent requests for the same invoice may impact performance
+  - Use appropriate headers to handle the binary response in your application (e.g., setting `Content-Type: application/pdf`)
+
 ### Resource `v1.customers.billing_config`:
 
-- `create_customers_v1_billing_config` (`write`): Set the billing configuration for a given customer.
-- `retrieve_customers_v1_billing_config` (`read`): Fetch the billing configuration for the given customer.
-- `delete_customers_v1_billing_config` (`write`): Delete the billing configuration for a given customer. Note: this is unsupported for Azure and AWS Marketplace customers.
+- `create_customers_v1_billing_config` (`write`): Set the billing configuration for a given customer. This is a Plans (deprecated) endpoint. New clients should implement using Contracts.
+- `retrieve_customers_v1_billing_config` (`read`): Fetch the billing configuration for the given customer. This is a Plans (deprecated) endpoint. New clients should implement using Contracts.
+- `delete_customers_v1_billing_config` (`write`): Delete the billing configuration for a given customer.
+  Note: this is unsupported for Azure and AWS Marketplace customers. This is a Plans (deprecated) endpoint. New clients should implement using Contracts.
 
 ### Resource `v1.customers.commits`:
 
@@ -638,7 +665,7 @@ The following tools are available in this MCP server.
 
   #### Billing configuration:
 
-  - invoice_contract_id is required for postpaid commits and for prepaid commits with billing (only optional for free prepaid commits)
+  - invoice_contract_id is required for postpaid commits and for prepaid commits with billing (only optional for free prepaid commits) unless do_not_invoice is set to true
   - For postpaid commits: access_schedule and invoice_schedule must have matching amounts
   - For postpaid commits: only one schedule item is allowed in both schedules.
 
@@ -845,7 +872,7 @@ The following tools are available in this MCP server.
   - Pagination: Use `next_page` cursor to retrieve large datasets
   - Null values: Group values may be null when no usage matches that group
 
-- `ingest_v1_usage` (`write`): The ingest endpoint is the primary method for sending usage events to Metronome, serving as the foundation for all billing calculations in your usage-based pricing model. This high-throughput endpoint is designed for real-time streaming ingestion, supports backdating 34 days, and is built to handle mission-critical usage data with enterprise-grade reliability. Metronome supports 100,000 events per second without requiring pre-aggregation or rollups and can scale up from there. See [Getting usage into Metronome](https://docs.metronome.com/connect-metronome/) to learn more about usage events.
+- `ingest_v1_usage` (`write`): The ingest endpoint is the primary method for sending usage events to Metronome, serving as the foundation for all billing calculations in your usage-based pricing model. This high-throughput endpoint is designed for real-time streaming ingestion, supports backdating 34 days, and is built to handle mission-critical usage data with enterprise-grade reliability. Metronome supports 100,000 events per second without requiring pre-aggregation or rollups and can scale up from there. See the [Send usage events](/guides/events/send-usage-events) guide to learn more about usage events.
 
   ### Use this endpoint to:
 
@@ -881,6 +908,8 @@ The following tools are available in this MCP server.
   }
   ```
 
+  Learn more about [usage event structure definitions](/guides/events/design-usage-events).
+
   #### Transaction ID
 
   The transaction_id serves as your idempotency key, ensuring events are processed exactly once. Metronome maintains a 34-day deduplication window - significantly longer than typical 12-hour windows - enabling robust backfill scenarios without duplicate billing.
@@ -1159,7 +1188,7 @@ The following tools are available in this MCP server.
 
   Manual ledger entries can be extremely useful for resolving discrepancies in Metronome. However, most corrections to inaccurate billings can be modified upstream of the commit, whether that is via contract editing, rate editing, or other actions that cause an invoice to be recalculated.
 
-- `amend_v1_contracts` (`write`): Amendments will be replaced by Contract editing. New clients should implement using the `editContract` endpoint. Read more about the migration to contract editing [here](https://docs.metronome.com/migrate-amendments-to-edits/) and reach out to your Metronome representative for more details. Once contract editing is enabled, access to this endpoint will be removed.
+- `amend_v1_contracts` (`write`): Amendments will be replaced by Contract editing. New clients should implement using the `editContract` endpoint. Read more about the migration to contract editing [here](/guides/implement-metronome/migrate-amendments-to-edits/) and reach out to your Metronome representative for more details. Once contract editing is enabled, access to this endpoint will be removed.
 - `archive_v1_contracts` (`write`): Permanently end and archive a contract along with all its terms. Any draft invoices will be canceled, and all upcoming scheduled invoices will be voided–also all finalized invoices can optionally be voided. Use this in the event a contract was incorrectly created and needed to be removed from a customer.
 
   #### Impact on commits and credits:
@@ -1222,7 +1251,7 @@ The following tools are available in this MCP server.
 
   To use usage filters, the `group_key` must be defined on the billable metrics underlying the rate card on the contracts.
 
-- `update_end_date_v1_contracts` (`write`): Update or and an end date to a contract. Ending a contract early will impact draft usage statements, truncate any terms, and remove upcoming scheduled invoices. Moving the date into the future will only extend the contract length. Terms and scheduled invoices are not extended. Use this if a contract's end date has changed or if a perpetual contract ends.
+- `update_end_date_v1_contracts` (`write`): Update or add an end date to a contract. Ending a contract early will impact draft usage statements, truncate any terms, and remove upcoming scheduled invoices. Moving the date into the future will only extend the contract length. Terms and scheduled invoices are not extended. In-advance subscriptions will not be extended. Use this if a contract's end date has changed or if a perpetual contract ends.
 
 ### Resource `v1.contracts.products`:
 
@@ -1320,3 +1349,26 @@ The following tools are available in this MCP server.
 
 - `retrieve_contracts_v1_named_schedules` (`write`): Get a named schedule for the given rate card. This endpoint's availability is dependent on your client's configuration.
 - `update_contracts_v1_named_schedules` (`write`): Update a named schedule for the given rate card. This endpoint's availability is dependent on your client's configuration.
+
+### Resource `v1.payments`:
+
+- `list_v1_payments` (`write`): Fetch all payment attempts for the given invoice.
+- `attempt_v1_payments` (`write`): Trigger a new attempt by canceling any existing attempts for this invoice and creating a new Payment. This will trigger another attempt to charge the Customer's configured Payment Gateway.
+  Payment can only be attempted if all of the following are true:
+
+  - The Metronome Invoice is finalized
+  - PLG Invoicing is configured for the Customer
+  - You cannot attempt payments for invoices that have already been `paid` or `voided`.
+
+  Attempting to payment on an ineligible Invoice or Customer will result in a `400` response.
+
+- `cancel_v1_payments` (`write`): Cancel an existing payment attempt for an invoice.
+
+### Resource `v1.settings`:
+
+- `upsert_avalara_credentials_v1_settings` (`write`): Set the Avalara credentials for some specified `delivery_method_ids`, which can be found in the `/listConfiguredBillingProviders` response. This maps the Avalara credentials to the appropriate billing entity. These credentials are only used for PLG Invoicing today.
+
+### Resource `v1.settings.billing_providers`:
+
+- `create_settings_v1_billing_providers` (`write`): Set up account-level configuration for a billing provider. Once configured, individual contracts across customers can be mapped to this configuration using the returned delivery_method_id.
+- `list_settings_v1_billing_providers` (`write`): Lists all configured billing providers and their delivery method configurations for your account. Returns provider details, delivery method IDs, and configuration settings needed for mapping individual customer contracts to billing integrations.

package/docs-search-tool.d.mts

@@ -0,0 +1,44 @@
+import { Metadata } from "./tools/types.mjs";
+import { Tool } from '@modelcontextprotocol/sdk/types.js';
+export declare const metadata: Metadata;
+export declare const tool: Tool;
+export declare const handler: (_: unknown, args: Record<string, unknown> | undefined) => Promise<import("./tools/types").ToolCallResult>;
+declare const _default: {
+    metadata: Metadata;
+    tool: {
+        [x: string]: unknown;
+        name: string;
+        inputSchema: {
+            [x: string]: unknown;
+            type: "object";
+            properties?: {
+                [x: string]: unknown;
+            } | undefined;
+            required?: string[] | undefined;
+        };
+        title?: string | undefined;
+        description?: string | undefined;
+        outputSchema?: {
+            [x: string]: unknown;
+            type: "object";
+            properties?: {
+                [x: string]: unknown;
+            } | undefined;
+            required?: string[] | undefined;
+        } | undefined;
+        annotations?: {
+            [x: string]: unknown;
+            title?: string | undefined;
+            readOnlyHint?: boolean | undefined;
+            destructiveHint?: boolean | undefined;
+            idempotentHint?: boolean | undefined;
+            openWorldHint?: boolean | undefined;
+        } | undefined;
+        _meta?: {
+            [x: string]: unknown;
+        } | undefined;
+    };
+    handler: (_: unknown, args: Record<string, unknown> | undefined) => Promise<import("./tools/types").ToolCallResult>;
+};
+export default _default;
+//# sourceMappingURL=docs-search-tool.d.mts.map

package/docs-search-tool.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"docs-search-tool.d.mts","sourceRoot":"","sources":["src/docs-search-tool.ts"],"names":[],"mappings":"OAEO,EAAE,QAAQ,EAAuB;OAEjC,EAAE,IAAI,EAAE,MAAM,oCAAoC;AAEzD,eAAO,MAAM,QAAQ,EAAE,QAKtB,CAAC;AAEF,eAAO,MAAM,IAAI,EAAE,IAsBlB,CAAC;AAKF,eAAO,MAAM,OAAO,GAAU,GAAG,OAAO,EAAE,MAAM,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,oDAKlF,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAL+B,OAAO,QAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS;;AAOnF,wBAA2C"}

package/docs-search-tool.d.ts

@@ -0,0 +1,44 @@
+import { Metadata } from "./tools/types.js";
+import { Tool } from '@modelcontextprotocol/sdk/types.js';
+export declare const metadata: Metadata;
+export declare const tool: Tool;
+export declare const handler: (_: unknown, args: Record<string, unknown> | undefined) => Promise<import("./tools/types").ToolCallResult>;
+declare const _default: {
+    metadata: Metadata;
+    tool: {
+        [x: string]: unknown;
+        name: string;
+        inputSchema: {
+            [x: string]: unknown;
+            type: "object";
+            properties?: {
+                [x: string]: unknown;
+            } | undefined;
+            required?: string[] | undefined;
+        };
+        title?: string | undefined;
+        description?: string | undefined;
+        outputSchema?: {
+            [x: string]: unknown;
+            type: "object";
+            properties?: {
+                [x: string]: unknown;
+            } | undefined;
+            required?: string[] | undefined;
+        } | undefined;
+        annotations?: {
+            [x: string]: unknown;
+            title?: string | undefined;
+            readOnlyHint?: boolean | undefined;
+            destructiveHint?: boolean | undefined;
+            idempotentHint?: boolean | undefined;
+            openWorldHint?: boolean | undefined;
+        } | undefined;
+        _meta?: {
+            [x: string]: unknown;
+        } | undefined;
+    };
+    handler: (_: unknown, args: Record<string, unknown> | undefined) => Promise<import("./tools/types").ToolCallResult>;
+};
+export default _default;
+//# sourceMappingURL=docs-search-tool.d.ts.map

package/docs-search-tool.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"docs-search-tool.d.ts","sourceRoot":"","sources":["src/docs-search-tool.ts"],"names":[],"mappings":"OAEO,EAAE,QAAQ,EAAuB;OAEjC,EAAE,IAAI,EAAE,MAAM,oCAAoC;AAEzD,eAAO,MAAM,QAAQ,EAAE,QAKtB,CAAC;AAEF,eAAO,MAAM,IAAI,EAAE,IAsBlB,CAAC;AAKF,eAAO,MAAM,OAAO,GAAU,GAAG,OAAO,EAAE,MAAM,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,oDAKlF,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAL+B,OAAO,QAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS;;AAOnF,wBAA2C"}

package/docs-search-tool.js

@@ -0,0 +1,43 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handler = exports.tool = exports.metadata = void 0;
+const types_1 = require("./tools/types.js");
+exports.metadata = {
+    resource: 'all',
+    operation: 'read',
+    tags: [],
+    httpMethod: 'get',
+};
+exports.tool = {
+    name: 'search_docs',
+    description: 'Search for documentation for how to use the client to interact with the API.\nThe tool will return an array of Markdown-formatted documentation pages.',
+    inputSchema: {
+        type: 'object',
+        properties: {
+            query: {
+                type: 'string',
+                description: 'The query to search for.',
+            },
+            language: {
+                type: 'string',
+                description: 'The language for the SDK to search for.',
+                enum: ['http', 'python', 'go', 'typescript', 'terraform', 'ruby', 'java', 'kotlin'],
+            },
+        },
+        required: ['query', 'language'],
+    },
+    annotations: {
+        readOnlyHint: true,
+    },
+};
+const docsSearchURL = process.env['DOCS_SEARCH_URL'] || 'https://api.stainless.com/api/projects/metronome/docs/search';
+const handler = async (_, args) => {
+    const body = args;
+    const query = new URLSearchParams(body).toString();
+    const result = await fetch(`${docsSearchURL}?${query}`);
+    return (0, types_1.asTextContentResult)(await result.json());
+};
+exports.handler = handler;
+exports.default = { metadata: exports.metadata, tool: exports.tool, handler: exports.handler };
+//# sourceMappingURL=docs-search-tool.js.map

package/docs-search-tool.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"docs-search-tool.js","sourceRoot":"","sources":["src/docs-search-tool.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,4CAA8D;AAIjD,QAAA,QAAQ,GAAa;IAChC,QAAQ,EAAE,KAAK;IACf,SAAS,EAAE,MAAM;IACjB,IAAI,EAAE,EAAE;IACR,UAAU,EAAE,KAAK;CAClB,CAAC;AAEW,QAAA,IAAI,GAAS;IACxB,IAAI,EAAE,aAAa;IACnB,WAAW,EACT,wJAAwJ;IAC1J,WAAW,EAAE;QACX,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE;YACV,KAAK,EAAE;gBACL,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,0BAA0B;aACxC;YACD,QAAQ,EAAE;gBACR,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,yCAAyC;gBACtD,IAAI,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,CAAC;aACpF;SACF;QACD,QAAQ,EAAE,CAAC,OAAO,EAAE,UAAU,CAAC;KAChC;IACD,WAAW,EAAE;QACX,YAAY,EAAE,IAAI;KACnB;CACF,CAAC;AAEF,MAAM,aAAa,GACjB,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,IAAI,8DAA8D,CAAC;AAE5F,MAAM,OAAO,GAAG,KAAK,EAAE,CAAU,EAAE,IAAyC,EAAE,EAAE;IACrF,MAAM,IAAI,GAAG,IAAW,CAAC;IACzB,MAAM,KAAK,GAAG,IAAI,eAAe,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,CAAC;IACnD,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,GAAG,aAAa,IAAI,KAAK,EAAE,CAAC,CAAC;IACxD,OAAO,IAAA,2BAAmB,EAAC,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;AAClD,CAAC,CAAC;AALW,QAAA,OAAO,WAKlB;AAEF,kBAAe,EAAE,QAAQ,EAAR,gBAAQ,EAAE,IAAI,EAAJ,YAAI,EAAE,OAAO,EAAP,eAAO,EAAE,CAAC"}

package/docs-search-tool.mjs

@@ -0,0 +1,39 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { asTextContentResult } from "./tools/types.mjs";
+export const metadata = {
+    resource: 'all',
+    operation: 'read',
+    tags: [],
+    httpMethod: 'get',
+};
+export const tool = {
+    name: 'search_docs',
+    description: 'Search for documentation for how to use the client to interact with the API.\nThe tool will return an array of Markdown-formatted documentation pages.',
+    inputSchema: {
+        type: 'object',
+        properties: {
+            query: {
+                type: 'string',
+                description: 'The query to search for.',
+            },
+            language: {
+                type: 'string',
+                description: 'The language for the SDK to search for.',
+                enum: ['http', 'python', 'go', 'typescript', 'terraform', 'ruby', 'java', 'kotlin'],
+            },
+        },
+        required: ['query', 'language'],
+    },
+    annotations: {
+        readOnlyHint: true,
+    },
+};
+const docsSearchURL = process.env['DOCS_SEARCH_URL'] || 'https://api.stainless.com/api/projects/metronome/docs/search';
+export const handler = async (_, args) => {
+    const body = args;
+    const query = new URLSearchParams(body).toString();
+    const result = await fetch(`${docsSearchURL}?${query}`);
+    return asTextContentResult(await result.json());
+};
+export default { metadata, tool, handler };
+//# sourceMappingURL=docs-search-tool.mjs.map

package/docs-search-tool.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"docs-search-tool.mjs","sourceRoot":"","sources":["src/docs-search-tool.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAY,mBAAmB,EAAE;AAIxC,MAAM,CAAC,MAAM,QAAQ,GAAa;IAChC,QAAQ,EAAE,KAAK;IACf,SAAS,EAAE,MAAM;IACjB,IAAI,EAAE,EAAE;IACR,UAAU,EAAE,KAAK;CAClB,CAAC;AAEF,MAAM,CAAC,MAAM,IAAI,GAAS;IACxB,IAAI,EAAE,aAAa;IACnB,WAAW,EACT,wJAAwJ;IAC1J,WAAW,EAAE;QACX,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE;YACV,KAAK,EAAE;gBACL,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,0BAA0B;aACxC;YACD,QAAQ,EAAE;gBACR,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,yCAAyC;gBACtD,IAAI,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,CAAC;aACpF;SACF;QACD,QAAQ,EAAE,CAAC,OAAO,EAAE,UAAU,CAAC;KAChC;IACD,WAAW,EAAE;QACX,YAAY,EAAE,IAAI;KACnB;CACF,CAAC;AAEF,MAAM,aAAa,GACjB,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,IAAI,8DAA8D,CAAC;AAEnG,MAAM,CAAC,MAAM,OAAO,GAAG,KAAK,EAAE,CAAU,EAAE,IAAyC,EAAE,EAAE;IACrF,MAAM,IAAI,GAAG,IAAW,CAAC;IACzB,MAAM,KAAK,GAAG,IAAI,eAAe,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,CAAC;IACnD,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,GAAG,aAAa,IAAI,KAAK,EAAE,CAAC,CAAC;IACxD,OAAO,mBAAmB,CAAC,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;AAClD,CAAC,CAAC;AAEF,eAAe,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC"}

package/options.d.mts

@@ -11,6 +11,7 @@ export type McpOptions = {
     includeDynamicTools?: boolean | undefined;
     includeAllTools?: boolean | undefined;
     includeCodeTools?: boolean | undefined;
+    includeDocsTools?: boolean | undefined;
     filters?: Filter[] | undefined;
     capabilities?: Partial<ClientCapabilities> | undefined;
 };

package/options.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"options.d.mts","sourceRoot":"","sources":["src/options.ts"],"names":[],"mappings":"OAIO,EAAa,MAAM,EAAE;OACrB,EAAE,kBAAkB,EAAgB,UAAU,EAAE;AAEvD,MAAM,MAAM,UAAU,GAAG,UAAU,GAAG;IACpC,IAAI,EAAE,OAAO,CAAC;IACd,SAAS,EAAE,OAAO,GAAG,MAAM,CAAC;IAC5B,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG;IACvB,MAAM,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;IAChC,mBAAmB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC1C,eAAe,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACtC,gBAAgB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACvC,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IAC/B,YAAY,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,GAAG,SAAS,CAAC;CACxD,CAAC;AA+BF,wBAAgB,eAAe,IAAI,UAAU,CA0N5C;AA+BD,wBAAgB,iBAAiB,CAAC,cAAc,EAAE,UAAU,EAAE,KAAK,EAAE,OAAO,GAAG,UAAU,CAqFxF"}
+{"version":3,"file":"options.d.mts","sourceRoot":"","sources":["src/options.ts"],"names":[],"mappings":"OAIO,EAAa,MAAM,EAAE;OACrB,EAAE,kBAAkB,EAAgB,UAAU,EAAE;AAEvD,MAAM,MAAM,UAAU,GAAG,UAAU,GAAG;IACpC,IAAI,EAAE,OAAO,CAAC;IACd,SAAS,EAAE,OAAO,GAAG,MAAM,CAAC;IAC5B,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG;IACvB,MAAM,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;IAChC,mBAAmB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC1C,eAAe,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACtC,gBAAgB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACvC,gBAAgB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACvC,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IAC/B,YAAY,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,GAAG,SAAS,CAAC;CACxD,CAAC;AA+BF,wBAAgB,eAAe,IAAI,UAAU,CA6N5C;AA+BD,wBAAgB,iBAAiB,CAAC,cAAc,EAAE,UAAU,EAAE,KAAK,EAAE,OAAO,GAAG,UAAU,CA2FxF"}

package/options.d.ts

@@ -11,6 +11,7 @@ export type McpOptions = {
     includeDynamicTools?: boolean | undefined;
     includeAllTools?: boolean | undefined;
     includeCodeTools?: boolean | undefined;
+    includeDocsTools?: boolean | undefined;
     filters?: Filter[] | undefined;
     capabilities?: Partial<ClientCapabilities> | undefined;
 };

package/options.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"options.d.ts","sourceRoot":"","sources":["src/options.ts"],"names":[],"mappings":"OAIO,EAAa,MAAM,EAAE;OACrB,EAAE,kBAAkB,EAAgB,UAAU,EAAE;AAEvD,MAAM,MAAM,UAAU,GAAG,UAAU,GAAG;IACpC,IAAI,EAAE,OAAO,CAAC;IACd,SAAS,EAAE,OAAO,GAAG,MAAM,CAAC;IAC5B,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG;IACvB,MAAM,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;IAChC,mBAAmB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC1C,eAAe,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACtC,gBAAgB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACvC,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IAC/B,YAAY,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,GAAG,SAAS,CAAC;CACxD,CAAC;AA+BF,wBAAgB,eAAe,IAAI,UAAU,CA0N5C;AA+BD,wBAAgB,iBAAiB,CAAC,cAAc,EAAE,UAAU,EAAE,KAAK,EAAE,OAAO,GAAG,UAAU,CAqFxF"}
+{"version":3,"file":"options.d.ts","sourceRoot":"","sources":["src/options.ts"],"names":[],"mappings":"OAIO,EAAa,MAAM,EAAE;OACrB,EAAE,kBAAkB,EAAgB,UAAU,EAAE;AAEvD,MAAM,MAAM,UAAU,GAAG,UAAU,GAAG;IACpC,IAAI,EAAE,OAAO,CAAC;IACd,SAAS,EAAE,OAAO,GAAG,MAAM,CAAC;IAC5B,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG;IACvB,MAAM,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;IAChC,mBAAmB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC1C,eAAe,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACtC,gBAAgB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACvC,gBAAgB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACvC,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IAC/B,YAAY,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,GAAG,SAAS,CAAC;CACxD,CAAC;AA+BF,wBAAgB,eAAe,IAAI,UAAU,CA6N5C;AA+BD,wBAAgB,iBAAiB,CAAC,cAAc,EAAE,UAAU,EAAE,KAAK,EAAE,OAAO,GAAG,UAAU,CA2FxF"}