@metronome/mcp 0.1.0-beta.12 → 0.2.0

package/src/tools/v1/contracts/create-v1-contracts.ts

@@ -16,8 +16,7 @@ export const metadata: Metadata = {
 
 export const tool: Tool = {
   name: 'create_v1_contracts',
-  description:
-    "When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance.\n\nOnly omit if you're sure you don't need the data.\n\nCreate a new contract\n",
+  description: 'Create a new contract\n',
   inputSchema: {
     type: 'object',
     properties: {
@@ -1112,6 +1111,53 @@ export const tool: Tool = {
               description: 'Determines when the contract will stop creating recurring commits. optional',
               format: 'date-time',
             },
+            hierarchy_configuration: {
+              type: 'object',
+              description: 'Optional configuration for recurring commit/credit hierarchy access control',
+              properties: {
+                child_access: {
+                  anyOf: [
+                    {
+                      type: 'object',
+                      properties: {
+                        type: {
+                          type: 'string',
+                          enum: ['ALL'],
+                        },
+                      },
+                      required: ['type'],
+                    },
+                    {
+                      type: 'object',
+                      properties: {
+                        type: {
+                          type: 'string',
+                          enum: ['NONE'],
+                        },
+                      },
+                      required: ['type'],
+                    },
+                    {
+                      type: 'object',
+                      properties: {
+                        contract_ids: {
+                          type: 'array',
+                          items: {
+                            type: 'string',
+                          },
+                        },
+                        type: {
+                          type: 'string',
+                          enum: ['CONTRACT_IDS'],
+                        },
+                      },
+                      required: ['contract_ids', 'type'],
+                    },
+                  ],
+                },
+              },
+              required: ['child_access'],
+            },
             invoice_amount: {
               type: 'object',
               description: 'The amount the customer should be billed for the commit. Not required.',
@@ -1187,6 +1233,32 @@ export const tool: Tool = {
                 },
               },
             },
+            subscription_config: {
+              type: 'object',
+              description: 'Attach a subscription to the recurring commit/credit.',
+              properties: {
+                apply_seat_increase_config: {
+                  type: 'object',
+                  properties: {
+                    is_prorated: {
+                      type: 'boolean',
+                      description: 'Indicates whether a mid-period seat increase should be prorated.',
+                    },
+                  },
+                  required: ['is_prorated'],
+                },
+                subscription_id: {
+                  type: 'string',
+                  description: 'ID of the subscription to configure on the recurring commit/credit.',
+                },
+                allocation: {
+                  type: 'string',
+                  description: 'If set to POOLED, allocation added per seat is pooled across the account.',
+                  enum: ['POOLED'],
+                },
+              },
+              required: ['apply_seat_increase_config', 'subscription_id'],
+            },
             temporary_id: {
               type: 'string',
               description:
@@ -1269,6 +1341,53 @@ export const tool: Tool = {
               description: 'Determines when the contract will stop creating recurring commits. optional',
               format: 'date-time',
             },
+            hierarchy_configuration: {
+              type: 'object',
+              description: 'Optional configuration for recurring commit/credit hierarchy access control',
+              properties: {
+                child_access: {
+                  anyOf: [
+                    {
+                      type: 'object',
+                      properties: {
+                        type: {
+                          type: 'string',
+                          enum: ['ALL'],
+                        },
+                      },
+                      required: ['type'],
+                    },
+                    {
+                      type: 'object',
+                      properties: {
+                        type: {
+                          type: 'string',
+                          enum: ['NONE'],
+                        },
+                      },
+                      required: ['type'],
+                    },
+                    {
+                      type: 'object',
+                      properties: {
+                        contract_ids: {
+                          type: 'array',
+                          items: {
+                            type: 'string',
+                          },
+                        },
+                        type: {
+                          type: 'string',
+                          enum: ['CONTRACT_IDS'],
+                        },
+                      },
+                      required: ['contract_ids', 'type'],
+                    },
+                  ],
+                },
+              },
+              required: ['child_access'],
+            },
             name: {
               type: 'string',
               description: 'displayed on invoices. will be passed through to the individual commits',
@@ -1328,6 +1447,32 @@ export const tool: Tool = {
                 },
               },
             },
+            subscription_config: {
+              type: 'object',
+              description: 'Attach a subscription to the recurring commit/credit.',
+              properties: {
+                apply_seat_increase_config: {
+                  type: 'object',
+                  properties: {
+                    is_prorated: {
+                      type: 'boolean',
+                      description: 'Indicates whether a mid-period seat increase should be prorated.',
+                    },
+                  },
+                  required: ['is_prorated'],
+                },
+                subscription_id: {
+                  type: 'string',
+                  description: 'ID of the subscription to configure on the recurring commit/credit.',
+                },
+                allocation: {
+                  type: 'string',
+                  description: 'If set to POOLED, allocation added per seat is pooled across the account.',
+                  enum: ['POOLED'],
+                },
+              },
+              required: ['apply_seat_increase_config', 'subscription_id'],
+            },
             temporary_id: {
               type: 'string',
               description:
@@ -1626,7 +1771,7 @@ export const tool: Tool = {
                 invoice_behavior: {
                   type: 'string',
                   description:
-                    'Indicates how mid-period quantity adjustments are invoiced. If BILL_IMMEDIATELY is selected, the quantity increase will be billed on the scheduled date. If BILL_ON_NEXT_COLLECTION_DATE is selected, the quantity increase will be billed for in-arrears at the end of the period.',
+                    'Indicates how mid-period quantity adjustments are invoiced. \n**BILL_IMMEDIATELY**: Only available when collection schedule is `ADVANCE`. The quantity increase will be billed immediately on the scheduled date.\n**BILL_ON_NEXT_COLLECTION_DATE**: The quantity increase will be billed for in-arrears at the end of the period.',
                   enum: ['BILL_IMMEDIATELY', 'BILL_ON_NEXT_COLLECTION_DATE'],
                 },
                 is_prorated: {
@@ -1672,6 +1817,11 @@ export const tool: Tool = {
                 'Inclusive start time for the subscription. If not provided, defaults to contract start date',
               format: 'date-time',
             },
+            temporary_id: {
+              type: 'string',
+              description:
+                'A temporary ID used to reference the subscription in recurring commit/credit subscription configs created within the same payload.',
+            },
           },
           required: ['collection_schedule', 'initial_quantity', 'proration', 'subscription_rate'],
         },
@@ -1776,6 +1926,7 @@ export const tool: Tool = {
       },
     },
   },
+  annotations: {},
 };
 
 export const handler = async (client: Metronome, args: Record<string, unknown> | undefined) => {

package/src/tools/v1/contracts/list-balances-v1-contracts.ts

@@ -16,8 +16,7 @@ export const metadata: Metadata = {
 
 export const tool: Tool = {
   name: 'list_balances_v1_contracts',
-  description:
-    "When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance.\n\nOnly omit if you're sure you don't need the data.\n\nList balances (commits and credits).\n",
+  description: 'List balances (commits and credits).\n',
   inputSchema: {
     type: 'object',
     properties: {
@@ -54,6 +53,10 @@ export const tool: Tool = {
         type: 'boolean',
         description: 'Include ledgers in the response. Setting this flag may cause the query to be slower.',
       },
+      limit: {
+        type: 'integer',
+        description: 'The maximum number of commits to return. Defaults to 25.',
+      },
       next_page: {
         type: 'string',
         description: 'The next page token from a previous response.',
@@ -66,6 +69,7 @@ export const tool: Tool = {
     },
     required: ['customer_id'],
   },
+  annotations: {},
 };
 
 export const handler = async (client: Metronome, args: Record<string, unknown> | undefined) => {

package/src/tools/v1/contracts/list-v1-contracts.ts

@@ -17,7 +17,7 @@ export const metadata: Metadata = {
 export const tool: Tool = {
   name: 'list_v1_contracts',
   description:
-    "When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance.\n\nOnly omit if you're sure you don't need the data.\n\nThis is the v1 endpoint to list all contracts for a customer. New clients should implement using the v2 endpoint.",
+    'This is the v1 endpoint to list all contracts for a customer. New clients should implement using the v2 endpoint.',
   inputSchema: {
     type: 'object',
     properties: {
@@ -53,6 +53,7 @@ export const tool: Tool = {
     },
     required: ['customer_id'],
   },
+  annotations: {},
 };
 
 export const handler = async (client: Metronome, args: Record<string, unknown> | undefined) => {

package/src/tools/v1/contracts/named-schedules/retrieve-contracts-v1-named-schedules.ts

@@ -45,12 +45,13 @@ export const tool: Tool = {
     },
     required: ['rate_card_id', 'schedule_name'],
   },
+  annotations: {},
 };
 
 export const handler = async (client: Metronome, args: Record<string, unknown> | undefined) => {
-  const body = args as any;
+  const { jq_filter, ...body } = args as any;
   return asTextContentResult(
-    await maybeFilter(args, await client.v1.contracts.namedSchedules.retrieve(body)),
+    await maybeFilter(jq_filter, await client.v1.contracts.namedSchedules.retrieve(body)),
   );
 };
 

package/src/tools/v1/contracts/named-schedules/update-contracts-v1-named-schedules.ts

@@ -17,7 +17,7 @@ export const metadata: Metadata = {
 export const tool: Tool = {
   name: 'update_contracts_v1_named_schedules',
   description:
-    "When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance.\n\nOnly omit if you're sure you don't need the data.\n\nUpdate a named schedule for the given rate card. This endpoint's availability is dependent on your client's configuration.\n\n# Response Schema\n```json\n{\n  type: 'object',\n  properties: {}\n}\n```",
+    "Update a named schedule for the given rate card. This endpoint's availability is dependent on your client's configuration.",
   inputSchema: {
     type: 'object',
     properties: {
@@ -42,15 +42,10 @@ export const tool: Tool = {
         type: 'string',
         format: 'date-time',
       },
-      jq_filter: {
-        type: 'string',
-        title: 'jq Filter',
-        description:
-          'A jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available.\n\nFor example: to include only the `name` field in every object of a results array, you can provide ".results[].name".\n\nFor more information, see the [jq documentation](https://jqlang.org/manual/).',
-      },
     },
     required: ['rate_card_id', 'schedule_name', 'starting_at', 'value'],
   },
+  annotations: {},
 };
 
 export const handler = async (client: Metronome, args: Record<string, unknown> | undefined) => {

package/src/tools/v1/contracts/products/archive-contracts-v1-products.ts

@@ -35,11 +35,12 @@ export const tool: Tool = {
     },
     required: ['product_id'],
   },
+  annotations: {},
 };
 
 export const handler = async (client: Metronome, args: Record<string, unknown> | undefined) => {
-  const body = args as any;
-  return asTextContentResult(await maybeFilter(args, await client.v1.contracts.products.archive(body)));
+  const { jq_filter, ...body } = args as any;
+  return asTextContentResult(await maybeFilter(jq_filter, await client.v1.contracts.products.archive(body)));
 };
 
 export default { metadata, tool, handler };

package/src/tools/v1/contracts/products/create-contracts-v1-products.ts

@@ -141,11 +141,12 @@ export const tool: Tool = {
       },
     },
   },
+  annotations: {},
 };
 
 export const handler = async (client: Metronome, args: Record<string, unknown> | undefined) => {
-  const body = args as any;
-  return asTextContentResult(await maybeFilter(args, await client.v1.contracts.products.create(body)));
+  const { jq_filter, ...body } = args as any;
+  return asTextContentResult(await maybeFilter(jq_filter, await client.v1.contracts.products.create(body)));
 };
 
 export default { metadata, tool, handler };

package/src/tools/v1/contracts/products/list-contracts-v1-products.ts

@@ -44,12 +44,13 @@ export const tool: Tool = {
     },
     required: [],
   },
+  annotations: {},
 };
 
 export const handler = async (client: Metronome, args: Record<string, unknown> | undefined) => {
-  const body = args as any;
+  const { jq_filter, ...body } = args as any;
   const response = await client.v1.contracts.products.list(body).asResponse();
-  return asTextContentResult(await maybeFilter(args, await response.json()));
+  return asTextContentResult(await maybeFilter(jq_filter, await response.json()));
 };
 
 export default { metadata, tool, handler };

package/src/tools/v1/contracts/products/retrieve-contracts-v1-products.ts

@@ -34,11 +34,12 @@ export const tool: Tool = {
     },
     required: ['id'],
   },
+  annotations: {},
 };
 
 export const handler = async (client: Metronome, args: Record<string, unknown> | undefined) => {
-  const body = args as any;
-  return asTextContentResult(await maybeFilter(args, await client.v1.contracts.products.retrieve(body)));
+  const { jq_filter, ...body } = args as any;
+  return asTextContentResult(await maybeFilter(jq_filter, await client.v1.contracts.products.retrieve(body)));
 };
 
 export default { metadata, tool, handler };

package/src/tools/v1/contracts/products/update-contracts-v1-products.ts

@@ -153,11 +153,12 @@ export const tool: Tool = {
       },
     },
   },
+  annotations: {},
 };
 
 export const handler = async (client: Metronome, args: Record<string, unknown> | undefined) => {
-  const body = args as any;
-  return asTextContentResult(await maybeFilter(args, await client.v1.contracts.products.update(body)));
+  const { jq_filter, ...body } = args as any;
+  return asTextContentResult(await maybeFilter(jq_filter, await client.v1.contracts.products.update(body)));
 };
 
 export default { metadata, tool, handler };

package/src/tools/v1/contracts/rate-cards/archive-contracts-v1-rate-cards.ts

@@ -34,11 +34,12 @@ export const tool: Tool = {
     },
     required: ['id'],
   },
+  annotations: {},
 };
 
 export const handler = async (client: Metronome, args: Record<string, unknown> | undefined) => {
-  const body = args as any;
-  return asTextContentResult(await maybeFilter(args, await client.v1.contracts.rateCards.archive(body)));
+  const { jq_filter, ...body } = args as any;
+  return asTextContentResult(await maybeFilter(jq_filter, await client.v1.contracts.rateCards.archive(body)));
 };
 
 export default { metadata, tool, handler };

package/src/tools/v1/contracts/rate-cards/create-contracts-v1-rate-cards.ts

@@ -84,11 +84,12 @@ export const tool: Tool = {
     },
     required: ['name'],
   },
+  annotations: {},
 };
 
 export const handler = async (client: Metronome, args: Record<string, unknown> | undefined) => {
-  const body = args as any;
-  return asTextContentResult(await maybeFilter(args, await client.v1.contracts.rateCards.create(body)));
+  const { jq_filter, ...body } = args as any;
+  return asTextContentResult(await maybeFilter(jq_filter, await client.v1.contracts.rateCards.create(body)));
 };
 
 export default { metadata, tool, handler };

package/src/tools/v1/contracts/rate-cards/list-contracts-v1-rate-cards.ts

@@ -42,12 +42,13 @@ export const tool: Tool = {
     },
     required: [],
   },
+  annotations: {},
 };
 
 export const handler = async (client: Metronome, args: Record<string, unknown> | undefined) => {
-  const body = args as any;
+  const { jq_filter, ...body } = args as any;
   const response = await client.v1.contracts.rateCards.list(body).asResponse();
-  return asTextContentResult(await maybeFilter(args, await response.json()));
+  return asTextContentResult(await maybeFilter(jq_filter, await response.json()));
 };
 
 export default { metadata, tool, handler };

package/src/tools/v1/contracts/rate-cards/named-schedules/retrieve-rate-cards-contracts-v1-named-schedules.ts

@@ -49,12 +49,13 @@ export const tool: Tool = {
     },
     required: ['contract_id', 'customer_id', 'schedule_name'],
   },
+  annotations: {},
 };
 
 export const handler = async (client: Metronome, args: Record<string, unknown> | undefined) => {
-  const body = args as any;
+  const { jq_filter, ...body } = args as any;
   return asTextContentResult(
-    await maybeFilter(args, await client.v1.contracts.rateCards.namedSchedules.retrieve(body)),
+    await maybeFilter(jq_filter, await client.v1.contracts.rateCards.namedSchedules.retrieve(body)),
   );
 };
 

package/src/tools/v1/contracts/rate-cards/named-schedules/update-rate-cards-contracts-v1-named-schedules.ts

@@ -17,7 +17,7 @@ export const metadata: Metadata = {
 export const tool: Tool = {
   name: 'update_rate_cards_contracts_v1_named_schedules',
   description:
-    "When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance.\n\nOnly omit if you're sure you don't need the data.\n\nUpdate a named schedule for the given contract. This endpoint's availability is dependent on your client's configuration.\n\n# Response Schema\n```json\n{\n  type: 'object',\n  properties: {}\n}\n```",
+    "Update a named schedule for the given contract. This endpoint's availability is dependent on your client's configuration.",
   inputSchema: {
     type: 'object',
     properties: {
@@ -46,15 +46,10 @@ export const tool: Tool = {
         type: 'string',
         format: 'date-time',
       },
-      jq_filter: {
-        type: 'string',
-        title: 'jq Filter',
-        description:
-          'A jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available.\n\nFor example: to include only the `name` field in every object of a results array, you can provide ".results[].name".\n\nFor more information, see the [jq documentation](https://jqlang.org/manual/).',
-      },
     },
     required: ['contract_id', 'customer_id', 'schedule_name', 'starting_at', 'value'],
   },
+  annotations: {},
 };
 
 export const handler = async (client: Metronome, args: Record<string, unknown> | undefined) => {

package/src/tools/v1/contracts/rate-cards/product-orders/set-rate-cards-contracts-v1-product-orders.ts

@@ -41,12 +41,13 @@ export const tool: Tool = {
     },
     required: ['product_order', 'rate_card_id'],
   },
+  annotations: {},
 };
 
 export const handler = async (client: Metronome, args: Record<string, unknown> | undefined) => {
-  const body = args as any;
+  const { jq_filter, ...body } = args as any;
   return asTextContentResult(
-    await maybeFilter(args, await client.v1.contracts.rateCards.productOrders.set(body)),
+    await maybeFilter(jq_filter, await client.v1.contracts.rateCards.productOrders.set(body)),
   );
 };
 

package/src/tools/v1/contracts/rate-cards/product-orders/update-rate-cards-contracts-v1-product-orders.ts

@@ -52,12 +52,13 @@ export const tool: Tool = {
     },
     required: ['product_moves', 'rate_card_id'],
   },
+  annotations: {},
 };
 
 export const handler = async (client: Metronome, args: Record<string, unknown> | undefined) => {
-  const body = args as any;
+  const { jq_filter, ...body } = args as any;
   return asTextContentResult(
-    await maybeFilter(args, await client.v1.contracts.rateCards.productOrders.update(body)),
+    await maybeFilter(jq_filter, await client.v1.contracts.rateCards.productOrders.update(body)),
   );
 };
 

package/src/tools/v1/contracts/rate-cards/rates/add-many-rate-cards-contracts-v1-rates.ts

@@ -148,12 +148,13 @@ export const tool: Tool = {
       },
     },
   },
+  annotations: {},
 };
 
 export const handler = async (client: Metronome, args: Record<string, unknown> | undefined) => {
-  const body = args as any;
+  const { jq_filter, ...body } = args as any;
   return asTextContentResult(
-    await maybeFilter(args, await client.v1.contracts.rateCards.rates.addMany(body)),
+    await maybeFilter(jq_filter, await client.v1.contracts.rateCards.rates.addMany(body)),
   );
 };
 

package/src/tools/v1/contracts/rate-cards/rates/add-rate-cards-contracts-v1-rates.ts

@@ -139,11 +139,14 @@ export const tool: Tool = {
       },
     },
   },
+  annotations: {},
 };
 
 export const handler = async (client: Metronome, args: Record<string, unknown> | undefined) => {
-  const body = args as any;
-  return asTextContentResult(await maybeFilter(args, await client.v1.contracts.rateCards.rates.add(body)));
+  const { jq_filter, ...body } = args as any;
+  return asTextContentResult(
+    await maybeFilter(jq_filter, await client.v1.contracts.rateCards.rates.add(body)),
+  );
 };
 
 export default { metadata, tool, handler };

package/src/tools/v1/contracts/rate-cards/rates/list-rate-cards-contracts-v1-rates.ts

@@ -86,12 +86,13 @@ export const tool: Tool = {
     },
     required: ['at', 'rate_card_id'],
   },
+  annotations: {},
 };
 
 export const handler = async (client: Metronome, args: Record<string, unknown> | undefined) => {
-  const body = args as any;
+  const { jq_filter, ...body } = args as any;
   const response = await client.v1.contracts.rateCards.rates.list(body).asResponse();
-  return asTextContentResult(await maybeFilter(args, await response.json()));
+  return asTextContentResult(await maybeFilter(jq_filter, await response.json()));
 };
 
 export default { metadata, tool, handler };

package/src/tools/v1/contracts/rate-cards/retrieve-contracts-v1-rate-cards.ts

@@ -34,11 +34,14 @@ export const tool: Tool = {
     },
     required: ['id'],
   },
+  annotations: {},
 };
 
 export const handler = async (client: Metronome, args: Record<string, unknown> | undefined) => {
-  const body = args as any;
-  return asTextContentResult(await maybeFilter(args, await client.v1.contracts.rateCards.retrieve(body)));
+  const { jq_filter, ...body } = args as any;
+  return asTextContentResult(
+    await maybeFilter(jq_filter, await client.v1.contracts.rateCards.retrieve(body)),
+  );
 };
 
 export default { metadata, tool, handler };

package/src/tools/v1/contracts/rate-cards/retrieve-rate-schedule-contracts-v1-rate-cards.ts

@@ -84,12 +84,13 @@ export const tool: Tool = {
     },
     required: ['rate_card_id', 'starting_at'],
   },
+  annotations: {},
 };
 
 export const handler = async (client: Metronome, args: Record<string, unknown> | undefined) => {
-  const body = args as any;
+  const { jq_filter, ...body } = args as any;
   return asTextContentResult(
-    await maybeFilter(args, await client.v1.contracts.rateCards.retrieveRateSchedule(body)),
+    await maybeFilter(jq_filter, await client.v1.contracts.rateCards.retrieveRateSchedule(body)),
   );
 };
 

package/src/tools/v1/contracts/rate-cards/update-contracts-v1-rate-cards.ts

@@ -64,11 +64,12 @@ export const tool: Tool = {
     },
     required: ['rate_card_id'],
   },
+  annotations: {},
 };
 
 export const handler = async (client: Metronome, args: Record<string, unknown> | undefined) => {
-  const body = args as any;
-  return asTextContentResult(await maybeFilter(args, await client.v1.contracts.rateCards.update(body)));
+  const { jq_filter, ...body } = args as any;
+  return asTextContentResult(await maybeFilter(jq_filter, await client.v1.contracts.rateCards.update(body)));
 };
 
 export default { metadata, tool, handler };

package/src/tools/v1/contracts/retrieve-rate-schedule-v1-contracts.ts

@@ -91,11 +91,14 @@ export const tool: Tool = {
     },
     required: ['contract_id', 'customer_id'],
   },
+  annotations: {},
 };
 
 export const handler = async (client: Metronome, args: Record<string, unknown> | undefined) => {
-  const body = args as any;
-  return asTextContentResult(await maybeFilter(args, await client.v1.contracts.retrieveRateSchedule(body)));
+  const { jq_filter, ...body } = args as any;
+  return asTextContentResult(
+    await maybeFilter(jq_filter, await client.v1.contracts.retrieveRateSchedule(body)),
+  );
 };
 
 export default { metadata, tool, handler };

package/src/tools/v1/contracts/retrieve-subscription-quantity-history-v1-contracts.ts

@@ -40,12 +40,13 @@ export const tool: Tool = {
     },
     required: ['contract_id', 'customer_id', 'subscription_id'],
   },
+  annotations: {},
 };
 
 export const handler = async (client: Metronome, args: Record<string, unknown> | undefined) => {
-  const body = args as any;
+  const { jq_filter, ...body } = args as any;
   return asTextContentResult(
-    await maybeFilter(args, await client.v1.contracts.retrieveSubscriptionQuantityHistory(body)),
+    await maybeFilter(jq_filter, await client.v1.contracts.retrieveSubscriptionQuantityHistory(body)),
   );
 };