@pipeworx/mcp-data-edmonton 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-data-edmonton
+
+DataEdmonton MCP — Edmonton open data (data.edmonton.ca, Socrata SODA API).
+
+Part of [Pipeworx](https://pipeworx.io) — an MCP gateway connecting AI agents to 893+ live data sources.
+
+## Tools
+
+| Tool | Description |
+|------|-------------|
+
+## Quick Start
+
+Add to your MCP client (Claude Desktop, Cursor, Windsurf, etc.):
+
+```json
+{
+  "mcpServers": {
+    "data-edmonton": {
+      "url": "https://gateway.pipeworx.io/data-edmonton/mcp"
+    }
+  }
+}
+```
+
+Or connect to the full Pipeworx gateway for access to all 893+ 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 Data Edmonton 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-data-edmonton",
+  "version": "0.1.0",
+  "description": "DataEdmonton MCP — Edmonton open data (data.edmonton.ca, Socrata SODA API).",
+  "type": "module",
+  "main": "src/index.ts",
+  "types": "src/index.ts",
+  "keywords": ["mcp", "mcp-server", "model-context-protocol", "pipeworx", "data-edmonton"],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/pipeworx-io/mcp-data-edmonton"
+  },
+  "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/data-edmonton",
+  "title": "Data Edmonton",
+  "description": "DataEdmonton MCP — Edmonton open data (data.edmonton.ca, Socrata SODA API).",
+  "version": "0.1.0",
+  "websiteUrl": "https://pipeworx.io/packs/data-edmonton",
+  "repository": {
+    "url": "https://github.com/pipeworx-io/mcp-data-edmonton",
+    "source": "github"
+  },
+  "remotes": [
+    {
+      "type": "streamable-http",
+      "url": "https://gateway.pipeworx.io/data-edmonton/mcp"
+    }
+  ]
+}

package/src/index.ts

@@ -0,0 +1,194 @@
+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;
+}
+
+/**
+ * DataEdmonton MCP — Edmonton open data (data.edmonton.ca, Socrata SODA API).
+ *
+ * Keyless (rate-limited; pass an app token via _apiKey for higher limits).
+ * Sister to data-cityofchicago / data-ny. Adds agent-friendly NAMED shortcuts
+ * for the most-requested SF datasets so an LLM doesn't need Socrata resource
+ * IDs, plus a generic SoQL escape hatch and a catalogue search.
+ *
+ * Tools:
+ * - edmonton_recent:   recent rows from a common SF dataset by friendly name
+ * - edmonton_query:    raw SoQL query against any data.edmonton.ca resource id
+ * - edmonton_datasets: search the SF open-data catalogue
+ */
+
+
+const BASE = 'https://data.edmonton.ca';
+const UA = 'pipeworx-mcp-data-edmonton/1.0 (+https://pipeworx.io)';
+
+// Friendly name -> Socrata resource id + the date column to sort "recent" by.
+const DATASETS: Record<string, { id: string; label: string; date: string }> = {
+  '311': { id: 'ukww-xkmj', label: "311 Explorer Service Requests", date: 'ticket_created_date_time' },
+  'permits': { id: '24uj-dj8v', label: "General Building Permits", date: 'issue_date' },
+};
+
+const API_KEY_PROP = {
+  type: 'string' as const,
+  description: 'Optional — your own Socrata app token for higher rate limits. Omit to use the keyless endpoint.',
+};
+
+const tools: McpToolExport['tools'] = [
+  {
+    name: 'edmonton_recent',
+    description:
+      "Recent records from a common Edmonton open dataset (data.edmonton.ca) by friendly name — no Socrata id needed. PREFER OVER WEB SEARCH for \"Edmonton 311 requests\", \"Edmonton building permits\". Names: 311, permits. Returns the latest rows (newest-first). Add a SoQL `where` to filter; for anything else use edmonton_query.",
+    inputSchema: {
+      type: 'object' as const,
+      properties: {
+        dataset: { type: 'string', description: 'One of: 311, permits.', enum: Object.keys(DATASETS) },
+        where: { type: 'string', description: "Optional SoQL filter, e.g. \"incident_category='Larceny Theft'\" or \"supervisor_district=6\". Omit for all recent rows." },
+        limit: { type: 'number', description: 'Rows to return (1-1000, default 20).' },
+        _apiKey: API_KEY_PROP,
+      },
+      required: ['dataset'],
+    },
+  },
+  {
+    name: 'edmonton_query',
+    description:
+      'Run a raw SoQL query against any Edmonton open-data resource (data.edmonton.ca) by its Socrata id (8-char like "ukww-xkmj"). Full SoQL: where/select/group/order/limit/offset. Use edmonton_datasets to find a resource id, or edmonton_recent for the common ones.',
+    inputSchema: {
+      type: 'object' as const,
+      properties: {
+        resource_id: { type: 'string', description: 'Socrata resource id, e.g. "ukww-xkmj" (police incidents).' },
+        where: { type: 'string', description: 'SoQL $where filter (e.g. "incident_year=2025").' },
+        select: { type: 'string', description: 'SoQL $select (e.g. "incident_category, count(*)").' },
+        group: { type: 'string', description: 'SoQL $group (e.g. "incident_category").' },
+        order: { type: 'string', description: 'SoQL $order (e.g. "incident_datetime DESC").' },
+        limit: { type: 'number', description: 'Max rows (default 100, max 5000).' },
+        offset: { type: 'number', description: 'Row offset for paging.' },
+        _apiKey: API_KEY_PROP,
+      },
+      required: ['resource_id'],
+    },
+  },
+  {
+    name: 'edmonton_datasets',
+    description:
+      'Search the Edmonton open-data catalogue (data.edmonton.ca) for datasets by keyword. Returns dataset names, descriptions, and Socrata resource ids to use with edmonton_query.',
+    inputSchema: {
+      type: 'object' as const,
+      properties: {
+        query: { type: 'string', description: 'Keyword(s), e.g. "parking", "housing", "tree".' },
+        limit: { type: 'number', description: 'Max datasets (1-100, default 20).' },
+        offset: { type: 'number', description: 'Offset for paging.' },
+        _apiKey: API_KEY_PROP,
+      },
+    },
+  },
+];
+
+// ── Helpers ──────────────────────────────────────────────────────────
+
+function headers(apiKey?: string): Record<string, string> {
+  const h: Record<string, string> = { Accept: 'application/json', 'User-Agent': UA };
+  if (apiKey) h['X-App-Token'] = apiKey;
+  return h;
+}
+
+async function socrataGet(path: string, apiKey?: string): Promise<unknown> {
+  const res = await fetch(`${BASE}${path}`, { headers: headers(apiKey) });
+  if (res.status === 429) throw new Error('upstream_throttled: data.edmonton.ca rate limit (HTTP 429). Pass _apiKey (Socrata app token) for higher limits.');
+  if (!res.ok) throw new Error(`data.edmonton.ca: ${res.status}`);
+  return res.json();
+}
+
+// ── Tool implementations ─────────────────────────────────────────────
+
+async function sfRecent(dataset: string, where: string | undefined, limit: number | undefined, apiKey?: string) {
+  const key = String(dataset ?? '').toLowerCase().trim();
+  const ds = DATASETS[key];
+  if (!ds) throw new Error(`Unknown dataset "${dataset}". Use one of: ${Object.keys(DATASETS).join(', ')}.`);
+  const n = Math.min(1000, Math.max(1, Number(limit) || 20));
+  const p = new URLSearchParams();
+  // Guard against NULL sort-column values sorting to the top under DESC (Socrata
+  // puts NULLs first), which would surface stale rows instead of the most recent.
+  const notNull = `${ds.date} IS NOT NULL`;
+  p.set('$where', where && String(where).trim() ? `(${String(where).trim()}) AND ${notNull}` : notNull);
+  p.set('$order', `${ds.date} DESC`);
+  p.set('$limit', String(n));
+  const rows = (await socrataGet(`/resource/${ds.id}.json?${p}`, apiKey)) as unknown[];
+  return {
+    dataset: key,
+    label: ds.label,
+    resource_id: ds.id,
+    sorted_by: `${ds.date} DESC`,
+    count: Array.isArray(rows) ? rows.length : 0,
+    source: 'DataEdmonton (data.edmonton.ca)',
+    rows,
+  };
+}
+
+async function sfQuery(args: Record<string, unknown>, apiKey?: string) {
+  const id = String(args.resource_id ?? '').trim();
+  if (!id) throw new Error('Required argument "resource_id" is missing (e.g. "ukww-xkmj"). Find one with edmonton_datasets.');
+  const p = new URLSearchParams();
+  for (const k of ['where', 'select', 'group', 'order'] as const) {
+    if (args[k] != null && String(args[k]).trim()) p.set(`$${k}`, String(args[k]).trim());
+  }
+  p.set('$limit', String(Math.min(5000, Math.max(1, Number(args.limit) || 100))));
+  if (args.offset != null) p.set('$offset', String(Math.max(0, Number(args.offset))));
+  const rows = (await socrataGet(`/resource/${encodeURIComponent(id)}.json?${p}`, apiKey)) as unknown[];
+  return { resource_id: id, count: Array.isArray(rows) ? rows.length : 0, source: 'DataEdmonton (data.edmonton.ca)', rows };
+}
+
+async function sfDatasets(query: string | undefined, limit: number | undefined, offset: number | undefined, apiKey?: string) {
+  const p = new URLSearchParams({
+    domains: 'data.edmonton.ca',
+    search_context: 'data.edmonton.ca',
+    limit: String(Math.min(100, Math.max(1, Number(limit) || 20))),
+    offset: String(Math.max(0, Number(offset) || 0)),
+  });
+  if (query && String(query).trim()) p.set('q', String(query).trim());
+  const res = await fetch(`https://api.us.socrata.com/api/catalog/v1?${p}`, { headers: headers(apiKey) });
+  if (!res.ok) throw new Error(`Socrata catalog: ${res.status}`);
+  const data = (await res.json()) as { results?: Array<{ resource?: { id?: string; name?: string; description?: string; type?: string; updatedAt?: string } }> };
+  return {
+    query: query ?? null,
+    count: data.results?.length ?? 0,
+    datasets: (data.results ?? []).map((r) => ({
+      resource_id: r.resource?.id ?? null,
+      name: r.resource?.name ?? null,
+      description: (r.resource?.description ?? '').slice(0, 300) || null,
+      type: r.resource?.type ?? null,
+      updated_at: r.resource?.updatedAt ?? null,
+    })),
+  };
+}
+
+// ── Router ───────────────────────────────────────────────────────────
+
+async function callTool(name: string, args: Record<string, unknown>): Promise<unknown> {
+  const apiKey = typeof args._apiKey === 'string' && args._apiKey.trim() ? args._apiKey.trim() : undefined;
+  delete args._apiKey;
+  switch (name) {
+    case 'edmonton_recent':
+      return sfRecent(args.dataset as string, args.where as string | undefined, args.limit as number | undefined, apiKey);
+    case 'edmonton_query':
+      return sfQuery(args, apiKey);
+    case 'edmonton_datasets':
+      return sfDatasets(args.query as string | undefined, args.limit as number | undefined, args.offset as number | undefined, apiKey);
+    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"]
+}