recurly-mcp 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (127) hide show
  1. package/CHANGELOG.md +61 -0
  2. package/LICENSE +21 -0
  3. package/README.md +179 -0
  4. package/dist/bin.d.ts +2 -0
  5. package/dist/bin.js +19 -0
  6. package/dist/bin.js.map +1 -0
  7. package/dist/client/errors.d.ts +16 -0
  8. package/dist/client/errors.js +44 -0
  9. package/dist/client/errors.js.map +1 -0
  10. package/dist/client/pagination.d.ts +8 -0
  11. package/dist/client/pagination.js +33 -0
  12. package/dist/client/pagination.js.map +1 -0
  13. package/dist/client/recurly.d.ts +19 -0
  14. package/dist/client/recurly.js +277 -0
  15. package/dist/client/recurly.js.map +1 -0
  16. package/dist/config.d.ts +9 -0
  17. package/dist/config.js +99 -0
  18. package/dist/config.js.map +1 -0
  19. package/dist/responseGuard.d.ts +1 -0
  20. package/dist/responseGuard.js +124 -0
  21. package/dist/responseGuard.js.map +1 -0
  22. package/dist/server.d.ts +7 -0
  23. package/dist/server.js +119 -0
  24. package/dist/server.js.map +1 -0
  25. package/dist/tools/accounts.d.ts +217 -0
  26. package/dist/tools/accounts.js +71 -0
  27. package/dist/tools/accounts.js.map +1 -0
  28. package/dist/tools/addOns.d.ts +46 -0
  29. package/dist/tools/addOns.js +24 -0
  30. package/dist/tools/addOns.js.map +1 -0
  31. package/dist/tools/billingInfo.d.ts +57 -0
  32. package/dist/tools/billingInfo.js +31 -0
  33. package/dist/tools/billingInfo.js.map +1 -0
  34. package/dist/tools/businessEntities.d.ts +80 -0
  35. package/dist/tools/businessEntities.js +32 -0
  36. package/dist/tools/businessEntities.js.map +1 -0
  37. package/dist/tools/couponRedemptions.d.ts +135 -0
  38. package/dist/tools/couponRedemptions.js +57 -0
  39. package/dist/tools/couponRedemptions.js.map +1 -0
  40. package/dist/tools/coupons.d.ts +86 -0
  41. package/dist/tools/coupons.js +37 -0
  42. package/dist/tools/coupons.js.map +1 -0
  43. package/dist/tools/creditPayments.d.ts +73 -0
  44. package/dist/tools/creditPayments.js +28 -0
  45. package/dist/tools/creditPayments.js.map +1 -0
  46. package/dist/tools/customFieldDefinitions.d.ts +46 -0
  47. package/dist/tools/customFieldDefinitions.js +32 -0
  48. package/dist/tools/customFieldDefinitions.js.map +1 -0
  49. package/dist/tools/dunningCampaigns.d.ts +42 -0
  50. package/dist/tools/dunningCampaigns.js +21 -0
  51. package/dist/tools/dunningCampaigns.js.map +1 -0
  52. package/dist/tools/exports.d.ts +20 -0
  53. package/dist/tools/exports.js +21 -0
  54. package/dist/tools/exports.js.map +1 -0
  55. package/dist/tools/externalAccounts.d.ts +48 -0
  56. package/dist/tools/externalAccounts.js +28 -0
  57. package/dist/tools/externalAccounts.js.map +1 -0
  58. package/dist/tools/externalInvoices.d.ts +73 -0
  59. package/dist/tools/externalInvoices.js +28 -0
  60. package/dist/tools/externalInvoices.js.map +1 -0
  61. package/dist/tools/externalProducts.d.ts +85 -0
  62. package/dist/tools/externalProducts.js +34 -0
  63. package/dist/tools/externalProducts.js.map +1 -0
  64. package/dist/tools/externalSubscriptions.d.ts +147 -0
  65. package/dist/tools/externalSubscriptions.js +47 -0
  66. package/dist/tools/externalSubscriptions.js.map +1 -0
  67. package/dist/tools/generalLedgerAccounts.d.ts +46 -0
  68. package/dist/tools/generalLedgerAccounts.js +32 -0
  69. package/dist/tools/generalLedgerAccounts.js.map +1 -0
  70. package/dist/tools/giftCards.d.ts +42 -0
  71. package/dist/tools/giftCards.js +21 -0
  72. package/dist/tools/giftCards.js.map +1 -0
  73. package/dist/tools/index.d.ts +2 -0
  74. package/dist/tools/index.js +68 -0
  75. package/dist/tools/index.js.map +1 -0
  76. package/dist/tools/invoiceTemplates.d.ts +83 -0
  77. package/dist/tools/invoiceTemplates.js +39 -0
  78. package/dist/tools/invoiceTemplates.js.map +1 -0
  79. package/dist/tools/invoices.d.ts +168 -0
  80. package/dist/tools/invoices.js +58 -0
  81. package/dist/tools/invoices.js.map +1 -0
  82. package/dist/tools/items.d.ts +46 -0
  83. package/dist/tools/items.js +24 -0
  84. package/dist/tools/items.js.map +1 -0
  85. package/dist/tools/lineItems.d.ts +93 -0
  86. package/dist/tools/lineItems.js +37 -0
  87. package/dist/tools/lineItems.js.map +1 -0
  88. package/dist/tools/measuredUnits.d.ts +46 -0
  89. package/dist/tools/measuredUnits.js +24 -0
  90. package/dist/tools/measuredUnits.js.map +1 -0
  91. package/dist/tools/performanceObligations.d.ts +42 -0
  92. package/dist/tools/performanceObligations.js +24 -0
  93. package/dist/tools/performanceObligations.js.map +1 -0
  94. package/dist/tools/plans.d.ts +93 -0
  95. package/dist/tools/plans.js +34 -0
  96. package/dist/tools/plans.js.map +1 -0
  97. package/dist/tools/priceSegments.d.ts +42 -0
  98. package/dist/tools/priceSegments.js +21 -0
  99. package/dist/tools/priceSegments.js.map +1 -0
  100. package/dist/tools/request.d.ts +17 -0
  101. package/dist/tools/request.js +55 -0
  102. package/dist/tools/request.js.map +1 -0
  103. package/dist/tools/shared.d.ts +32 -0
  104. package/dist/tools/shared.js +73 -0
  105. package/dist/tools/shared.js.map +1 -0
  106. package/dist/tools/shippingAddresses.d.ts +48 -0
  107. package/dist/tools/shippingAddresses.js +28 -0
  108. package/dist/tools/shippingAddresses.js.map +1 -0
  109. package/dist/tools/shippingMethods.d.ts +42 -0
  110. package/dist/tools/shippingMethods.js +21 -0
  111. package/dist/tools/shippingMethods.js.map +1 -0
  112. package/dist/tools/sites.d.ts +46 -0
  113. package/dist/tools/sites.js +24 -0
  114. package/dist/tools/sites.js.map +1 -0
  115. package/dist/tools/subscriptions.d.ts +178 -0
  116. package/dist/tools/subscriptions.js +68 -0
  117. package/dist/tools/subscriptions.js.map +1 -0
  118. package/dist/tools/transactions.d.ts +87 -0
  119. package/dist/tools/transactions.js +36 -0
  120. package/dist/tools/transactions.js.map +1 -0
  121. package/dist/tools/types.d.ts +13 -0
  122. package/dist/tools/types.js +2 -0
  123. package/dist/tools/types.js.map +1 -0
  124. package/dist/tools/usage.d.ts +52 -0
  125. package/dist/tools/usage.js +33 -0
  126. package/dist/tools/usage.js.map +1 -0
  127. package/package.json +77 -0
@@ -0,0 +1,36 @@
1
+ import { z } from 'zod';
2
+ import { enc, fetchList, idParam, listParamsSchema } from './shared.js';
3
+ const transactionFilters = {
4
+ type: z.string().optional().describe('Filter by transaction type, e.g. authorization, purchase.'),
5
+ success: z.string().optional().describe('Filter by success ("true"/"false").'),
6
+ };
7
+ const inputSchema = z.discriminatedUnion('action', [
8
+ z
9
+ .object({ action: z.literal('list') })
10
+ .merge(listParamsSchema)
11
+ .extend(transactionFilters),
12
+ z.object({ action: z.literal('get'), transaction_id: idParam('transaction_id') }),
13
+ z
14
+ .object({ action: z.literal('list_for_account'), account_id: idParam('account_id') })
15
+ .merge(listParamsSchema)
16
+ .extend(transactionFilters),
17
+ ]);
18
+ export const transactionsTool = {
19
+ name: 'recurly_transactions',
20
+ description: 'Recurly transactions (read-only). Actions: list (site-wide), get (one by ID or `uuid-<uuid>`), list_for_account. Returns raw Recurly JSON; list actions add a _pagination cursor hint.',
21
+ inputSchema,
22
+ handler: async (ctx, input) => {
23
+ const parsed = inputSchema.parse(input);
24
+ switch (parsed.action) {
25
+ case 'list':
26
+ return fetchList(ctx, '/transactions', parsed);
27
+ case 'get':
28
+ return ctx.client.request('GET', `/transactions/${enc(parsed.transaction_id)}`);
29
+ case 'list_for_account':
30
+ return fetchList(ctx, `/accounts/${enc(parsed.account_id)}/transactions`, parsed, [
31
+ 'account_id',
32
+ ]);
33
+ }
34
+ },
35
+ };
36
+ //# sourceMappingURL=transactions.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"transactions.js","sourceRoot":"","sources":["../../src/tools/transactions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,GAAG,EAAE,SAAS,EAAE,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAGxE,MAAM,kBAAkB,GAAG;IACzB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,2DAA2D,CAAC;IACjG,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,qCAAqC,CAAC;CAC/E,CAAC;AAEF,MAAM,WAAW,GAAG,CAAC,CAAC,kBAAkB,CAAC,QAAQ,EAAE;IACjD,CAAC;SACE,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;SACrC,KAAK,CAAC,gBAAgB,CAAC;SACvB,MAAM,CAAC,kBAAkB,CAAC;IAC7B,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,cAAc,EAAE,OAAO,CAAC,gBAAgB,CAAC,EAAE,CAAC;IACjF,CAAC;SACE,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC,EAAE,UAAU,EAAE,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC;SACpF,KAAK,CAAC,gBAAgB,CAAC;SACvB,MAAM,CAAC,kBAAkB,CAAC;CAC9B,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,gBAAgB,GAAuC;IAClE,IAAI,EAAE,sBAAsB;IAC5B,WAAW,EACT,wLAAwL;IAC1L,WAAW;IACX,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE;QAC5B,MAAM,MAAM,GAAG,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACxC,QAAQ,MAAM,CAAC,MAAM,EAAE,CAAC;YACtB,KAAK,MAAM;gBACT,OAAO,SAAS,CAAC,GAAG,EAAE,eAAe,EAAE,MAAM,CAAC,CAAC;YACjD,KAAK,KAAK;gBACR,OAAO,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,iBAAiB,GAAG,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC;YAClF,KAAK,kBAAkB;gBACrB,OAAO,SAAS,CAAC,GAAG,EAAE,aAAa,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,eAAe,EAAE,MAAM,EAAE;oBAChF,YAAY;iBACb,CAAC,CAAC;QACP,CAAC;IACH,CAAC;CACF,CAAC"}
@@ -0,0 +1,13 @@
1
+ import type { z } from 'zod';
2
+ import type { RecurlyClient } from '../client/recurly.js';
3
+ import type { Config } from '../config.js';
4
+ export interface ToolContext {
5
+ client: RecurlyClient;
6
+ config: Config;
7
+ }
8
+ export interface ToolDefinition<TInput extends z.ZodTypeAny> {
9
+ name: string;
10
+ description: string;
11
+ inputSchema: TInput;
12
+ handler: (ctx: ToolContext, input: z.infer<TInput>) => Promise<unknown>;
13
+ }
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=types.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/tools/types.ts"],"names":[],"mappings":""}
@@ -0,0 +1,52 @@
1
+ import { z } from 'zod';
2
+ import type { ToolDefinition } from './types.js';
3
+ declare const inputSchema: z.ZodDiscriminatedUnion<"action", [z.ZodObject<{
4
+ action: z.ZodLiteral<"list">;
5
+ subscription_id: z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>, string, string>;
6
+ add_on_id: z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>, string, string>;
7
+ } & {
8
+ limit: z.ZodOptional<z.ZodNumber>;
9
+ order: z.ZodOptional<z.ZodEnum<["asc", "desc"]>>;
10
+ sort: z.ZodOptional<z.ZodString>;
11
+ cursor: z.ZodOptional<z.ZodString>;
12
+ ids: z.ZodOptional<z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">>;
13
+ begin_time: z.ZodOptional<z.ZodString>;
14
+ end_time: z.ZodOptional<z.ZodString>;
15
+ } & {
16
+ billing_status: z.ZodOptional<z.ZodString>;
17
+ }, "strip", z.ZodTypeAny, {
18
+ action: "list";
19
+ add_on_id: string;
20
+ subscription_id: string;
21
+ cursor?: string | undefined;
22
+ limit?: number | undefined;
23
+ order?: "asc" | "desc" | undefined;
24
+ sort?: string | undefined;
25
+ ids?: string[] | undefined;
26
+ begin_time?: string | undefined;
27
+ end_time?: string | undefined;
28
+ billing_status?: string | undefined;
29
+ }, {
30
+ action: "list";
31
+ add_on_id: string;
32
+ subscription_id: string;
33
+ cursor?: string | undefined;
34
+ limit?: number | undefined;
35
+ order?: "asc" | "desc" | undefined;
36
+ sort?: string | undefined;
37
+ ids?: string[] | undefined;
38
+ begin_time?: string | undefined;
39
+ end_time?: string | undefined;
40
+ billing_status?: string | undefined;
41
+ }>, z.ZodObject<{
42
+ action: z.ZodLiteral<"get">;
43
+ usage_id: z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>, string, string>;
44
+ }, "strip", z.ZodTypeAny, {
45
+ action: "get";
46
+ usage_id: string;
47
+ }, {
48
+ action: "get";
49
+ usage_id: string;
50
+ }>]>;
51
+ export declare const usageTool: ToolDefinition<typeof inputSchema>;
52
+ export {};
@@ -0,0 +1,33 @@
1
+ import { z } from 'zod';
2
+ import { enc, fetchList, idParam, listParamsSchema } from './shared.js';
3
+ const inputSchema = z.discriminatedUnion('action', [
4
+ z
5
+ .object({
6
+ action: z.literal('list'),
7
+ subscription_id: idParam('subscription_id'),
8
+ add_on_id: idParam('add_on_id'),
9
+ })
10
+ .merge(listParamsSchema)
11
+ .extend({
12
+ billing_status: z
13
+ .string()
14
+ .optional()
15
+ .describe('Filter by billing status: unbilled, billed, or all.'),
16
+ }),
17
+ z.object({ action: z.literal('get'), usage_id: idParam('usage_id') }),
18
+ ]);
19
+ export const usageTool = {
20
+ name: 'recurly_usage',
21
+ description: 'Recurly usage records (read-only) for a metered subscription add-on. Actions: list (requires subscription_id and add_on_id), get (one usage record by ID). Returns raw Recurly JSON; list adds a _pagination cursor hint.',
22
+ inputSchema,
23
+ handler: async (ctx, input) => {
24
+ const parsed = inputSchema.parse(input);
25
+ switch (parsed.action) {
26
+ case 'list':
27
+ return fetchList(ctx, `/subscriptions/${enc(parsed.subscription_id)}/add_ons/${enc(parsed.add_on_id)}/usage`, parsed, ['subscription_id', 'add_on_id']);
28
+ case 'get':
29
+ return ctx.client.request('GET', `/usage/${enc(parsed.usage_id)}`);
30
+ }
31
+ },
32
+ };
33
+ //# sourceMappingURL=usage.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"usage.js","sourceRoot":"","sources":["../../src/tools/usage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,GAAG,EAAE,SAAS,EAAE,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAGxE,MAAM,WAAW,GAAG,CAAC,CAAC,kBAAkB,CAAC,QAAQ,EAAE;IACjD,CAAC;SACE,MAAM,CAAC;QACN,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC;QACzB,eAAe,EAAE,OAAO,CAAC,iBAAiB,CAAC;QAC3C,SAAS,EAAE,OAAO,CAAC,WAAW,CAAC;KAChC,CAAC;SACD,KAAK,CAAC,gBAAgB,CAAC;SACvB,MAAM,CAAC;QACN,cAAc,EAAE,CAAC;aACd,MAAM,EAAE;aACR,QAAQ,EAAE;aACV,QAAQ,CAAC,qDAAqD,CAAC;KACnE,CAAC;IACJ,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,QAAQ,EAAE,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;CACtE,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,SAAS,GAAuC;IAC3D,IAAI,EAAE,eAAe;IACrB,WAAW,EACT,2NAA2N;IAC7N,WAAW;IACX,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE;QAC5B,MAAM,MAAM,GAAG,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACxC,QAAQ,MAAM,CAAC,MAAM,EAAE,CAAC;YACtB,KAAK,MAAM;gBACT,OAAO,SAAS,CACd,GAAG,EACH,kBAAkB,GAAG,CAAC,MAAM,CAAC,eAAe,CAAC,YAAY,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,QAAQ,EACtF,MAAM,EACN,CAAC,iBAAiB,EAAE,WAAW,CAAC,CACjC,CAAC;YACJ,KAAK,KAAK;gBACR,OAAO,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,UAAU,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;QACvE,CAAC;IACH,CAAC;CACF,CAAC"}
package/package.json ADDED
@@ -0,0 +1,77 @@
1
+ {
2
+ "name": "recurly-mcp",
3
+ "version": "0.1.0",
4
+ "description": "Read-only MCP (Model Context Protocol) server exposing the Recurly v2021-02-25 API to LLM clients — accounts, subscriptions, invoices, transactions, plans, coupons, line items, and the rest of Recurly's read surface.",
5
+ "keywords": [
6
+ "mcp",
7
+ "mcp-server",
8
+ "model-context-protocol",
9
+ "recurly",
10
+ "billing",
11
+ "subscriptions",
12
+ "invoicing",
13
+ "payments",
14
+ "llm-tools",
15
+ "ai-tools"
16
+ ],
17
+ "author": "Franck Trouillez",
18
+ "license": "MIT",
19
+ "repository": {
20
+ "type": "git",
21
+ "url": "git+https://github.com/francktrouillez/recurly-mcp.git"
22
+ },
23
+ "bugs": {
24
+ "url": "https://github.com/francktrouillez/recurly-mcp/issues"
25
+ },
26
+ "homepage": "https://github.com/francktrouillez/recurly-mcp#readme",
27
+ "type": "module",
28
+ "bin": {
29
+ "recurly-mcp": "dist/bin.js"
30
+ },
31
+ "main": "dist/server.js",
32
+ "files": [
33
+ "dist",
34
+ "README.md",
35
+ "LICENSE",
36
+ "CHANGELOG.md"
37
+ ],
38
+ "scripts": {
39
+ "build": "rm -rf dist && tsc -p tsconfig.json",
40
+ "dev": "tsx src/bin.ts",
41
+ "test": "vitest run",
42
+ "test:watch": "vitest",
43
+ "lint": "eslint 'src/**/*.ts' 'test/**/*.ts'",
44
+ "typecheck": "tsc --noEmit",
45
+ "validate": "node scripts/validate-mcp.mjs 31",
46
+ "prepublishOnly": "npm run build"
47
+ },
48
+ "engines": {
49
+ "node": ">=20"
50
+ },
51
+ "prettier": {
52
+ "semi": true,
53
+ "singleQuote": true,
54
+ "trailingComma": "all",
55
+ "printWidth": 100,
56
+ "tabWidth": 2
57
+ },
58
+ "dependencies": {
59
+ "@modelcontextprotocol/sdk": "^1.0.0",
60
+ "zod": "^3.23.0",
61
+ "zod-to-json-schema": "^3.25.2"
62
+ },
63
+ "devDependencies": {
64
+ "@eslint/js": "^9.39.4",
65
+ "@types/node": "^20.14.0",
66
+ "@typescript-eslint/eslint-plugin": "^8.0.0",
67
+ "@typescript-eslint/parser": "^8.0.0",
68
+ "eslint": "^9.0.0",
69
+ "globals": "^17.6.0",
70
+ "nock": "^14.0.0",
71
+ "prettier": "^3.3.0",
72
+ "tsx": "^4.16.0",
73
+ "typescript": "^5.5.0",
74
+ "vitest": "^4.1.8",
75
+ "@vitest/coverage-v8": "^4.1.8"
76
+ }
77
+ }