@spritz-finance/mcp-server 0.2.0 → 0.3.0

package/README.md

@@ -33,9 +33,7 @@ npm install && npm run build
 
 ### 1. Get Your API Key
 
-1. Log in to [app.spritz.finance](https://app.spritz.finance)
-2. Go to **Settings > API Keys**
-3. Create a new key
+Create one at [app.spritz.finance/api-keys](https://app.spritz.finance/api-keys).
 
 ### 2. Configure Your MCP Client
 
@@ -95,24 +93,25 @@ Add to `~/.cursor/mcp.json`:
 
 | Tool | Description |
 |------|-------------|
-| `list_bank_accounts` | List all bank accounts saved as off-ramp payment destinations |
-
-More tools coming soon.
+| `list_bank_accounts` | List saved bank accounts |
+| `create_bank_account` | Add a bank account (US, CA, UK, or IBAN) |
+| `delete_bank_account` | Remove a bank account |
+| `list_off_ramps` | List off-ramp transactions with optional filters |
+| `create_off_ramp_quote` | Create a quote to convert crypto to fiat |
+| `get_off_ramp_quote` | Re-fetch a quote to check status |
+| `get_off_ramp_transaction` | Get transaction params (EVM calldata or Solana serialized tx) to sign and submit |
 
 ## Architecture
 
 Tools are driven by the OpenAPI spec — not hand-written. To expose a new endpoint, add one entry to `src/config.ts`:
 
 ```ts
-export const EXPOSED_TOOLS: ToolConfig[] = [
-  {
-    name: "list_bank_accounts",
-    operationId: "getV1Bank-accounts",
-    description: "List all bank accounts saved as off-ramp payment destinations.",
-  },
-  // To add a new tool, just add another entry here.
-  // The inputSchema, HTTP method, and path are all derived from the OpenAPI spec.
-];
+{
+  name: "list_bank_accounts",
+  operationId: "getV1Bank-accounts",
+  description: "List all bank accounts saved as off-ramp payment destinations.",
+},
+// Add more entries — inputSchema, HTTP method, and path are derived from the spec.
 ```
 
 The server reads `openapi.json`, finds each `operationId`, extracts the JSON Schema for parameters and request bodies, and registers them as MCP tools. A generic handler dispatches tool calls to the Spritz API.
@@ -122,7 +121,9 @@ openapi.json          → source of truth for request/response schemas
 src/config.ts         → which operations to expose (cherry-pick)
 src/spec.ts           → reads spec, builds MCP tool definitions
 src/handlers.ts       → generic dispatcher (path params, query, body)
-src/index.ts          → MCP server + API client
+src/formatters.ts     → CSV/JSON response formatting
+src/client.ts         → Spritz API HTTP client
+src/index.ts          → MCP server entrypoint
 ```
 
 ## Development

package/build/src/config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/config.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,WAAW,UAAU;IACzB,6CAA6C;IAC7C,IAAI,EAAE,MAAM,CAAC;IACb,wCAAwC;IACxC,WAAW,EAAE,MAAM,CAAC;IACpB,8CAA8C;IAC9C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,2FAA2F;IAC3F,MAAM,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;CACzB;AAED,eAAO,MAAM,aAAa,EAAE,UAAU,EA4BrC,CAAC"}
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/config.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,WAAW,UAAU;IACzB,6CAA6C;IAC7C,IAAI,EAAE,MAAM,CAAC;IACb,wCAAwC;IACxC,WAAW,EAAE,MAAM,CAAC;IACpB,8CAA8C;IAC9C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,2FAA2F;IAC3F,MAAM,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;CACzB;AAED,eAAO,MAAM,aAAa,EAAE,UAAU,EA8CrC,CAAC"}

package/build/src/config.js

@@ -26,10 +26,28 @@ export const EXPOSED_TOOLS = [
         operationId: "getV1Off-ramps",
         description: "List off-ramp transactions. Filter by status, chain, or destination accountId. Supports cursor pagination.",
     },
+    {
+        name: "get_off_ramp_quote",
+        operationId: "getV1Off-ramp-quotesByQuoteId",
+        description: "Get an off-ramp quote by ID. Use this to check quote status or re-fetch quote details.",
+        format: "json",
+    },
+    {
+        name: "get_off_ramp_transaction",
+        operationId: "postV1Off-ramp-quotesByQuoteIdTransaction",
+        description: "Get transaction params for a quote. Returns EVM calldata (contractAddress, calldata, value) or a serialized Solana transaction (transactionSerialized) depending on the chain. The agent must sign and submit the transaction on-chain.",
+        format: "json",
+    },
     {
         name: "create_off_ramp_quote",
         operationId: "postV1Off-ramp-quotes",
-        description: "Create an off-ramp quote to convert crypto to fiat. Specify the destination accountId, amount, and blockchain chain. Returns a quote with exchange rate and fees.",
+        description: `Create an off-ramp quote to convert crypto to fiat. Returns a quote with locked exchange rate, fees, and next steps.
+
+After creating a quote, check the \`fulfillment\` field:
+- \`send_to_address\`: Send the exact \`input.amount\` of \`input.token\` to the \`sendTo.address\` before \`sendTo.expiresAt\`.
+- \`sign_transaction\`: Call \`get_off_ramp_transaction\` with the quote ID and sender address to get calldata or a serialized transaction, then sign and submit on-chain.
+
+Amount modes: set \`amountType\` to \`output\` (default) for exact fiat delivery, or \`input\` for exact crypto spend.`,
         format: "json",
     },
 ];

package/build/src/config.js.map

@@ -1 +1 @@
-{"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/config.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAaH,MAAM,CAAC,MAAM,aAAa,GAAiB;IACzC;QACE,IAAI,EAAE,oBAAoB;QAC1B,WAAW,EAAE,oBAAoB;QACjC,WAAW,EAAE,gEAAgE;KAC9E;IACD;QACE,IAAI,EAAE,qBAAqB;QAC3B,WAAW,EAAE,qBAAqB;QAClC,WAAW,EAAE,0PAA0P;QACvQ,MAAM,EAAE,MAAM;KACf;IACD;QACE,IAAI,EAAE,qBAAqB;QAC3B,WAAW,EAAE,kCAAkC;QAC/C,WAAW,EAAE,8BAA8B;KAC5C;IACD;QACE,IAAI,EAAE,gBAAgB;QACtB,WAAW,EAAE,gBAAgB;QAC7B,WAAW,EAAE,4GAA4G;KAC1H;IACD;QACE,IAAI,EAAE,uBAAuB;QAC7B,WAAW,EAAE,uBAAuB;QACpC,WAAW,EAAE,mKAAmK;QAChL,MAAM,EAAE,MAAM;KACf;CACF,CAAC"}
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/config.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAaH,MAAM,CAAC,MAAM,aAAa,GAAiB;IACzC;QACE,IAAI,EAAE,oBAAoB;QAC1B,WAAW,EAAE,oBAAoB;QACjC,WAAW,EAAE,gEAAgE;KAC9E;IACD;QACE,IAAI,EAAE,qBAAqB;QAC3B,WAAW,EAAE,qBAAqB;QAClC,WAAW,EAAE,0PAA0P;QACvQ,MAAM,EAAE,MAAM;KACf;IACD;QACE,IAAI,EAAE,qBAAqB;QAC3B,WAAW,EAAE,kCAAkC;QAC/C,WAAW,EAAE,8BAA8B;KAC5C;IACD;QACE,IAAI,EAAE,gBAAgB;QACtB,WAAW,EAAE,gBAAgB;QAC7B,WAAW,EAAE,4GAA4G;KAC1H;IACD;QACE,IAAI,EAAE,oBAAoB;QAC1B,WAAW,EAAE,+BAA+B;QAC5C,WAAW,EAAE,wFAAwF;QACrG,MAAM,EAAE,MAAM;KACf;IACD;QACE,IAAI,EAAE,0BAA0B;QAChC,WAAW,EAAE,2CAA2C;QACxD,WAAW,EAAE,yOAAyO;QACtP,MAAM,EAAE,MAAM;KACf;IACD;QACE,IAAI,EAAE,uBAAuB;QAC7B,WAAW,EAAE,uBAAuB;QACpC,WAAW,EAAE;;;;;;uHAMsG;QACnH,MAAM,EAAE,MAAM;KACf;CACF,CAAC"}