askell-mcp 0.4.2 → 0.4.3

package/README.md

@@ -113,7 +113,7 @@ Typical agent workflow:
 | `askell_customer_overview`  | v1 customer + subscriptions              |
 | `askell_contract_overview`  | v2 subscription contract + billing runs  |
 | `askell_billing_run_triage` | v2 billing run (+ optional contract)     |
-| `askell_list_webhooks`      | List configured webhooks                 |
+| `askell_list_webhooks`      | List configured webhooks (`hmac_secret` redacted) |
 
 ### Resources
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "askell-mcp",
-  "version": "0.4.2",
+  "version": "0.4.3",
   "description": "MCP server for the Askell payment and subscription API (Bun + stdio)",
   "author": "Neschadin Oleksandr",
   "license": "MIT",
@@ -62,7 +62,7 @@
     "build:all": "bun run build && bun run build:linux-x64 && bun run build:linux-arm64 && bun run build:darwin-arm64 && bun run build:darwin-x64"
   },
   "devDependencies": {
-    "@types/bun": "1.4.0",
+    "@types/bun": "1.4.1",
     "typescript": "7.0.2"
   },
   "dependencies": {

package/spec/openapi-v2.json

@@ -5334,4 +5334,4 @@
       }
     }
   }
-}
+}

package/src/client/askell-client.ts

@@ -1,5 +1,6 @@
 import { normalizeBaseUrl, type AppConfig } from '../config.ts';
 import { normalizeApiPath } from './paths.ts';
+import { redactSecretsInText } from './redact.ts';
 import {
   buildBoundedListPayload,
   formatApiResponse,
@@ -182,10 +183,11 @@ export class AskellClient {
       try {
         parsed = JSON.parse(bodyText);
       } catch {
+        const text = redactSecretsInText(bodyText);
         return {
-          text: bodyText,
+          text,
           truncated: false,
-          byteLength: Buffer.byteLength(bodyText, 'utf8'),
+          byteLength: Buffer.byteLength(text, 'utf8'),
           ok: false,
           status: lastStatus,
         };

package/src/client/redact.ts

@@ -0,0 +1,54 @@
+const SECRET_KEYS = new Set(['hmac_secret']);
+
+const JSON_SECRET_STRING =
+  /"(hmac_secret)"\s*:\s*("(?:\\.|[^"\\])*")/g;
+
+export function formatRedactedSecret(value: unknown): string {
+  if (typeof value === 'string' && value.startsWith('<redacted')) {
+    return value;
+  }
+  if (typeof value === 'string') {
+    return `<redacted len=${value.length}>`;
+  }
+  return '<redacted>';
+}
+
+export function redactSensitiveFields(value: unknown): unknown {
+  if (Array.isArray(value)) {
+    return value.map(redactSensitiveFields);
+  }
+
+  if (value !== null && typeof value === 'object') {
+    const out: Record<string, unknown> = {};
+    for (const [key, nested] of Object.entries(
+      value as Record<string, unknown>,
+    )) {
+      out[key] = SECRET_KEYS.has(key)
+        ? formatRedactedSecret(nested)
+        : redactSensitiveFields(nested);
+    }
+    return out;
+  }
+
+  return value;
+}
+
+/** Fallback for non-JSON / truncated bodies. Leaves already-redacted values alone. */
+export function redactSecretsInText(text: string): string {
+  if (!text.includes('hmac_secret')) {
+    return text;
+  }
+
+  try {
+    return JSON.stringify(redactSensitiveFields(JSON.parse(text)));
+  } catch {
+    JSON_SECRET_STRING.lastIndex = 0;
+    return text.replace(JSON_SECRET_STRING, (_match, key: string, raw: string) => {
+      try {
+        return `"${key}": ${JSON.stringify(formatRedactedSecret(JSON.parse(raw)))}`;
+      } catch {
+        return `"${key}": ${JSON.stringify(formatRedactedSecret(undefined))}`;
+      }
+    });
+  }
+}

package/src/client/response-formatter.ts

@@ -1,3 +1,8 @@
+import {
+  redactSensitiveFields,
+  redactSecretsInText,
+} from './redact.ts';
+
 export interface FormattedResponse {
   text: string;
   truncated: boolean;
@@ -203,7 +208,8 @@ export function buildBoundedListPayload(input: {
   items: unknown[];
   maxBytes: number;
 }): FormattedResponse {
-  const { status, meta, items, maxBytes } = input;
+  const { status, meta, maxBytes } = input;
+  const items = input.items.map((item) => redactSensitiveFields(item));
 
   const attempts: Array<{
     items: unknown[];
@@ -334,13 +340,14 @@ export function formatApiResponse(
 ): FormattedResponse {
   const byteLength = Buffer.byteLength(bodyText, 'utf8');
   const truncated = byteLength > maxBytes;
-  const visibleBody = truncated ? truncateUtf8(bodyText, maxBytes) : bodyText;
+  const safeText = redactSecretsInText(bodyText);
+  const visibleBody = truncated ? truncateUtf8(safeText, maxBytes) : safeText;
 
   let parsedBody: unknown = visibleBody;
   try {
     parsedBody = JSON.parse(visibleBody);
   } catch {
-    // keep raw text
+    // keep redacted raw text
   }
 
   const payload = {

package/src/resources/register.ts

@@ -21,9 +21,10 @@ Rare historical payloads used \`{ event, data, ref?, sender? }\`. If both \`even
 
 ## Registering endpoints (v1 management API)
 
-- GET/POST \`/webhooks/\` · GET/PUT/PATCH/DELETE \`/webhooks/{id}/\` (secret key)
+- GET/POST \`/webhooks/\` · GET/PUT/PATCH/DELETE \`/webhooks/{id}/\` (secret key). Live GET \`/webhooks/{id}/\` exists even if OpenAPI omits it.
 - Create body: \`{ url, event }\` (\`event\` may be a specific type or a family wildcard like \`payment.*\`)
-- Create/get response includes \`hmac_secret\` (store it; Askell will not show it again in a useful way if you lose it) and \`hmac_digest\` (typically \`SHA512\`)
+- Askell returns plaintext \`hmac_secret\` on list, get, and create (it is re-readable, not create-only), plus \`hmac_digest\` (typically \`SHA512\`)
+- MCP tool output redacts \`hmac_secret\` to \`<redacted len=N>\`. Do not treat that placeholder as the real secret. Copy the secret from the Askell dashboard or a direct API call outside MCP.
 
 Tools: \`askell_list_webhooks\`, \`askell_call\` (GET), \`askell_mutate\` (POST/PUT/PATCH/DELETE).
 

package/src/server.ts

@@ -64,6 +64,7 @@ Safety:
 - Writes go through askell_mutate (destructiveHint). Reads go through askell_call (readOnlyHint).
 - mutationGate=auto (default): confirmation form only if this request's envelope declared form elicitation; otherwise the client's own tool-allow UI is the gate. elicit always returns a form (SDK refuses if the client cannot fulfil it). off never asks.
 - Large list responses are compacted (index of id/dates/plan/customer) to fit responseMaxBytes before dropping rows; check meta.truncatedByMaxBytes, meta.compacted, and meta.compactedMode.
+- Tool output redacts webhook hmac_secret to \`<redacted len=N>\` (Askell list/get/create return the plaintext secret).
 
 Resources:
 - askell://spec/v1 and askell://spec/v2 — bundled OpenAPI

package/src/tools/analysis.ts

@@ -278,7 +278,7 @@ export function registerAnalysisTools(
     {
       title: 'List configured webhooks (v1)',
       description:
-        'List Askell webhook endpoints configured for the account (management API only).',
+        'List Askell webhook endpoints configured for the account (management API only). hmac_secret is redacted in the tool output (`<redacted len=N>`); copy the real secret from the dashboard or a non-MCP API call.',
       inputSchema: z.object({
         page_size: z
           .int()

package/src/tools/call.ts

@@ -171,7 +171,7 @@ export function registerCallTools(
     {
       title: 'Call Askell API (read)',
       description:
-        'Read-only Askell API call (GET, HEAD) for any v1/v2 path. For POST/PUT/PATCH/DELETE use askell_mutate. Discover paths with askell_list_operations and askell_describe_operation first.',
+        'Read-only Askell API call (GET, HEAD) for any v1/v2 path. For POST/PUT/PATCH/DELETE use askell_mutate. Discover paths with askell_list_operations and askell_describe_operation first. Webhook hmac_secret is redacted in the response.',
       inputSchema: callInputSchema,
       annotations: {
         readOnlyHint: true,
@@ -190,7 +190,7 @@ export function registerCallTools(
     {
       title: 'Mutate Askell API',
       description:
-        'Mutating Askell API call (POST, PUT, PATCH, DELETE). Clients that declared form elicitation get a confirmation form; others rely on the client tool-approval UI. Use askell_call for GET. Discover paths with askell_list_operations and askell_describe_operation first.',
+        'Mutating Askell API call (POST, PUT, PATCH, DELETE). Clients that declared form elicitation get a confirmation form; others rely on the client tool-approval UI. Use askell_call for GET. Discover paths with askell_list_operations and askell_describe_operation first. Webhook hmac_secret is redacted in the response (including POST /webhooks/ create).',
       inputSchema: mutateInputSchema,
       annotations: {
         readOnlyHint: false,