@pipeworx/mcp-gunbroker 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Pipeworx
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,55 @@
+# mcp-gunbroker
+
+GunBroker MCP Pack — wraps the GunBroker firearms-marketplace API.
+
+Part of [Pipeworx](https://pipeworx.io) — an MCP gateway connecting AI agents to 250+ live data sources.
+
+## Tools
+
+| Tool | Description |
+|------|-------------|
+
+## Quick Start
+
+Add to your MCP client (Claude Desktop, Cursor, Windsurf, etc.):
+
+```json
+{
+  "mcpServers": {
+    "gunbroker": {
+      "url": "https://gateway.pipeworx.io/gunbroker/mcp"
+    }
+  }
+}
+```
+
+Or connect to the full Pipeworx gateway for access to all 250+ data sources:
+
+```json
+{
+  "mcpServers": {
+    "pipeworx": {
+      "url": "https://gateway.pipeworx.io/mcp"
+    }
+  }
+}
+```
+
+## Using with ask_pipeworx
+
+Instead of calling tools directly, you can ask questions in plain English:
+
+```
+ask_pipeworx({ question: "your question about Gunbroker data" })
+```
+
+The gateway picks the right tool and fills the arguments automatically.
+
+## More
+
+- [All tools and guides](https://github.com/pipeworx-io/examples)
+- [pipeworx.io](https://pipeworx.io)
+
+## License
+
+MIT

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@pipeworx/mcp-gunbroker",
+  "version": "0.1.0",
+  "description": "GunBroker MCP Pack — wraps the GunBroker firearms-marketplace API.",
+  "type": "module",
+  "main": "src/index.ts",
+  "types": "src/index.ts",
+  "keywords": ["mcp", "mcp-server", "model-context-protocol", "pipeworx", "gunbroker"],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/pipeworx-io/mcp-gunbroker"
+  },
+  "scripts": {
+    "typecheck": "tsc --noEmit"
+  },
+  "devDependencies": {
+    "typescript": "^5.7.0"
+  }
+}

package/server.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "https://static.modelcontextprotocol.io/schemas/2025-12-11/server.schema.json",
+  "name": "io.github.pipeworx-io/gunbroker",
+  "title": "Gunbroker",
+  "description": "GunBroker MCP Pack — wraps the GunBroker firearms-marketplace API.",
+  "version": "0.1.0",
+  "websiteUrl": "https://pipeworx.io/packs/gunbroker",
+  "repository": {
+    "url": "https://github.com/pipeworx-io/mcp-gunbroker",
+    "source": "github"
+  },
+  "remotes": [
+    {
+      "type": "streamable-http",
+      "url": "https://gateway.pipeworx.io/gunbroker/mcp"
+    }
+  ]
+}

package/src/index.ts

@@ -0,0 +1,191 @@
+interface McpToolDefinition {
+  name: string;
+  description: string;
+  inputSchema: {
+    type: 'object';
+    properties: Record<string, unknown>;
+    required?: string[];
+  };
+}
+
+interface McpToolExport {
+  tools: McpToolDefinition[];
+  callTool: (name: string, args: Record<string, unknown>) => Promise<unknown>;
+  meter?: { credits: number };
+  cost?: Record<string, unknown>;
+  provider?: string;
+}
+
+/**
+ * GunBroker MCP Pack — wraps the GunBroker firearms-marketplace API.
+ *
+ * BYO credentials (nothing is stored; every call is stateless):
+ *   - _apiKey: a GunBroker developer key, sent in the X-DevKey header on EVERY
+ *     request. Required for all tools. Request one from GunBroker API Support.
+ *   - username + password: required ONLY for seller tools (seller_orders). Used
+ *     to mint a short-lived access token via POST /Users/AccessToken, which is
+ *     then passed in the X-AccessToken header alongside X-DevKey.
+ *
+ * Endpoints used: GET /Items (search), GET /Items/{itemID} (detail),
+ * GET /OrdersSold (seller, token-gated), POST /Users/AccessToken (token mint).
+ *
+ * Base defaults to PRODUCTION (https://api.gunbroker.com/v1). GunBroker also
+ * runs a sandbox at https://api.sandbox.gunbroker.com/v1 with separate dev keys
+ * and accounts; this pack targets production.
+ *
+ * Quirks verified against the live API:
+ *   - A custom User-Agent header is mandatory — without it GunBroker returns
+ *     403 text/plain "Custom User Agent string required per GunBroker API Support".
+ *   - Missing/invalid X-DevKey returns 401 JSON with a developerMessage field.
+ *   Because error bodies may be JSON or plain text, we surface the raw body text.
+ */
+
+
+const BASE = 'https://api.gunbroker.com/v1';
+const UA = 'pipeworx-mcp-gunbroker/1.0 (+https://pipeworx.io)';
+
+function devHeaders(apiKey: string): Record<string, string> {
+  return {
+    'X-DevKey': apiKey,
+    'User-Agent': UA,
+    Accept: 'application/json',
+  };
+}
+
+async function gbGet(
+  apiKey: string,
+  path: string,
+  params?: URLSearchParams,
+  accessToken?: string,
+): Promise<unknown> {
+  const qs = params?.toString();
+  const url = `${BASE}${path}${qs ? `?${qs}` : ''}`;
+  const headers = devHeaders(apiKey);
+  if (accessToken) headers['X-AccessToken'] = accessToken;
+  const res = await fetch(url, { headers });
+  if (!res.ok) {
+    const body = await res.text();
+    throw new Error(`GunBroker: ${res.status} ${body.slice(0, 200)}`);
+  }
+  return res.json();
+}
+
+/**
+ * Exchange username + password for a seller access token. Stateless: the token
+ * is minted on every seller call and never persisted.
+ */
+async function getAccessToken(apiKey: string, username: string, password: string): Promise<string> {
+  const res = await fetch(`${BASE}/Users/AccessToken`, {
+    method: 'POST',
+    headers: { ...devHeaders(apiKey), 'Content-Type': 'application/json' },
+    body: JSON.stringify({ username, password }),
+  });
+  if (!res.ok) {
+    const body = await res.text();
+    throw new Error(`GunBroker: ${res.status} ${body.slice(0, 200)}`);
+  }
+  const data = (await res.json()) as Record<string, unknown>;
+  const token = (data.accessToken ?? data.AccessToken) as string | undefined;
+  if (!token) throw new Error(`GunBroker: token exchange returned no accessToken`);
+  return token;
+}
+
+// -- Tool definitions --------------------------------------------------------
+
+const tools: McpToolExport['tools'] = [
+  {
+    name: 'gunbroker_search_items',
+    description:
+      'Search active GunBroker firearms-marketplace listings by keyword (e.g. "Glock 19", "AR-15 lower", "Henri 22 rifle"). Returns matching live listings with item IDs, titles, current/buy-now prices, bid counts, and time left. Public — needs only a GunBroker developer key (_apiKey). Supports pagination and sort.',
+    inputSchema: {
+      type: 'object' as const,
+      properties: {
+        _apiKey: { type: 'string', description: 'GunBroker developer key (X-DevKey). Required.' },
+        Keywords: { type: 'string', description: 'Search keywords for active listings.' },
+        PageSize: { type: 'number', description: 'Results per page (default 25, max 300).' },
+        PageIndex: { type: 'number', description: 'Page number, 1-based (default 1).' },
+        Sort: {
+          type: 'number',
+          description:
+            'GunBroker sort code (e.g. 0=best match, 1=ending soonest, 13=lowest price). Optional.',
+        },
+      },
+      required: ['_apiKey'],
+    },
+  },
+  {
+    name: 'gunbroker_get_item',
+    description:
+      'Get full details for a single GunBroker listing by item ID — title, description, prices, seller, shipping, condition, category, and time remaining. Public — needs only a GunBroker developer key (_apiKey).',
+    inputSchema: {
+      type: 'object' as const,
+      properties: {
+        _apiKey: { type: 'string', description: 'GunBroker developer key (X-DevKey). Required.' },
+        itemID: { type: 'string', description: 'GunBroker numeric item ID.' },
+      },
+      required: ['_apiKey', 'itemID'],
+    },
+  },
+  {
+    name: 'gunbroker_seller_orders',
+    description:
+      "List the authenticated seller's sold orders (GunBroker /OrdersSold) — order IDs, buyers, item titles, totals, payment and shipping status. Seller tool: needs a GunBroker developer key (_apiKey) PLUS the seller's GunBroker username and password, which are exchanged for a short-lived access token on each call.",
+    inputSchema: {
+      type: 'object' as const,
+      properties: {
+        _apiKey: { type: 'string', description: 'GunBroker developer key (X-DevKey). Required.' },
+        username: { type: 'string', description: 'GunBroker seller account username. Required.' },
+        password: { type: 'string', description: 'GunBroker seller account password. Required.' },
+        PageSize: { type: 'number', description: 'Results per page (default 25, max 300).' },
+        PageIndex: { type: 'number', description: 'Page number, 1-based (default 1).' },
+        TimeFrame: {
+          type: 'number',
+          description:
+            'GunBroker time-frame filter for sold orders (e.g. recent N days). Optional.',
+        },
+      },
+      required: ['_apiKey', 'username', 'password'],
+    },
+  },
+];
+
+// -- callTool dispatcher -----------------------------------------------------
+
+async function callTool(name: string, args: Record<string, unknown>): Promise<unknown> {
+  const apiKey = args._apiKey as string | undefined;
+  const username = args.username as string | undefined;
+  const password = args.password as string | undefined;
+  delete args._context;
+  delete args._apiKey;
+  delete args.username;
+  delete args.password;
+
+  if (!apiKey) throw new Error('_apiKey (GunBroker developer key) is required for all GunBroker tools');
+
+  switch (name) {
+    case 'gunbroker_search_items': {
+      const params = new URLSearchParams();
+      if (args.Keywords) params.set('Keywords', String(args.Keywords));
+      params.set('PageSize', String(Math.min(300, (args.PageSize as number) ?? 25)));
+      params.set('PageIndex', String((args.PageIndex as number) ?? 1));
+      if (args.Sort !== undefined) params.set('Sort', String(args.Sort));
+      return gbGet(apiKey, '/Items', params);
+    }
+    case 'gunbroker_get_item':
+      return gbGet(apiKey, `/Items/${encodeURIComponent(String(args.itemID))}`);
+    case 'gunbroker_seller_orders': {
+      if (!username || !password)
+        throw new Error('username and password are required for gunbroker_seller_orders');
+      const token = await getAccessToken(apiKey, username, password);
+      const params = new URLSearchParams();
+      params.set('PageSize', String(Math.min(300, (args.PageSize as number) ?? 25)));
+      params.set('PageIndex', String((args.PageIndex as number) ?? 1));
+      if (args.TimeFrame !== undefined) params.set('TimeFrame', String(args.TimeFrame));
+      return gbGet(apiKey, '/OrdersSold', params, token);
+    }
+    default:
+      throw new Error(`Unknown tool: ${name}`);
+  }
+}
+
+export default { tools, callTool, meter: { credits: 1 } } satisfies McpToolExport;

package/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "outDir": "dist",
+    "rootDir": "src",
+    "declaration": true
+  },
+  "include": ["src"]
+}