@mountainpass/addressr-mcp 0.1.0

package/LICENSE

@@ -0,0 +1,123 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work.
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner.
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear.
+
+   5. Submission of Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor.
+
+   7. Disclaimer of Warranty.
+
+   8. Limitation of Liability.
+
+   9. Accepting Warranty or Additional Liability.
+
+   Copyright 2026 Mountain Pass Pty. Limited
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,104 @@
+# @mountainpass/addressr-mcp
+
+MCP (Model Context Protocol) server for Australian address search and validation powered by [Addressr](https://addressr.io).
+
+Search, validate, and retrieve detailed Australian address data from the Geocoded National Address File (G-NAF) — directly from your AI assistant.
+
+## Quick Start
+
+### 1. Get an API Key
+
+Sign up at [RapidAPI](https://rapidapi.com/addressr-addressr-default/api/addressr) to get your API key.
+
+### 2. Configure Your AI Client
+
+#### Claude Desktop
+
+Add to `~/Library/Application Support/Claude/claude_desktop_config.json`:
+
+```json
+{
+  "mcpServers": {
+    "addressr": {
+      "command": "npx",
+      "args": ["-y", "@mountainpass/addressr-mcp"],
+      "env": {
+        "RAPIDAPI_KEY": "your-rapidapi-key"
+      }
+    }
+  }
+}
+```
+
+#### Claude Code
+
+```bash
+claude mcp add addressr -- npx -y @mountainpass/addressr-mcp
+```
+
+Set `RAPIDAPI_KEY` in your environment.
+
+#### Cursor
+
+Add to `.cursor/mcp.json`:
+
+```json
+{
+  "mcpServers": {
+    "addressr": {
+      "command": "npx",
+      "args": ["-y", "@mountainpass/addressr-mcp"],
+      "env": {
+        "RAPIDAPI_KEY": "your-rapidapi-key"
+      }
+    }
+  }
+}
+```
+
+#### VS Code
+
+Add to `.vscode/mcp.json`:
+
+```json
+{
+  "servers": {
+    "addressr": {
+      "command": "npx",
+      "args": ["-y", "@mountainpass/addressr-mcp"],
+      "env": {
+        "RAPIDAPI_KEY": "your-rapidapi-key"
+      }
+    }
+  }
+}
+```
+
+## Available Tools
+
+### search-addresses
+
+Search Australian addresses by street, suburb, or postcode. Returns up to 8 results per page with standard address format, relevance score, and property ID (PID).
+
+**Parameters:**
+- `q` (required) — Search query, e.g. "1 george st sydney", "2000", "pyrmont nsw"
+- `page` (optional) — Page number for paginated results
+
+### get-address
+
+Get full address details by property ID (PID). Returns geocoding (lat/long), structured components (street, suburb, state, postcode, unit/flat), and confidence score.
+
+**Parameters:**
+- `addressId` (required) — G-NAF Property ID from search results, e.g. "GANSW710280564"
+
+### health
+
+Check API service status. Returns version, timestamp, and health status.
+
+## Data Source
+
+Address data is sourced from the [Geocoded National Address File (G-NAF)](https://data.gov.au/dataset/ds-dga-19432f89-dc3a-4ef3-b943-5326ef1dbecc), Australia's authoritative address database maintained by Geoscape Australia.
+
+## License
+
+Apache-2.0

package/bin/addressr-mcp.mjs

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+import '../src/server.mjs';

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "@mountainpass/addressr-mcp",
+  "version": "0.1.0",
+  "description": "MCP server for Australian address search and validation via Addressr",
+  "author": {
+    "name": "Mountain Pass",
+    "url": "https://mountain-pass.com.au"
+  },
+  "license": "Apache-2.0",
+  "type": "module",
+  "bin": {
+    "addressr-mcp": "./bin/addressr-mcp.mjs"
+  },
+  "files": [
+    "src/",
+    "bin/"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "scripts": {
+    "test": "node --test test/server.test.mjs",
+    "lint": "eslint .",
+    "pre-commit": "lint-staged",
+    "push:watch": "bash scripts/push-and-watch.sh"
+  },
+  "dependencies": {
+    "@modelcontextprotocol/sdk": "^1.29.0",
+    "zod": "^4.3.0"
+  },
+  "devDependencies": {
+    "@changesets/cli": "^2.29.7",
+    "@eslint/js": "^9.39.4",
+    "eslint": "^9.39.4",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-prettier": "^5.5.5",
+    "globals": "^17.4.0",
+    "husky": "^9.1.7",
+    "lint-staged": "^16.3.3",
+    "prettier": "^3.8.1"
+  },
+  "lint-staged": {
+    "*.{js,mjs}": "eslint --fix",
+    "*.{json,css,md}": "prettier --write"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mountain-pass/addressr-mcp.git"
+  },
+  "keywords": [
+    "mcp",
+    "model-context-protocol",
+    "addressr",
+    "australia",
+    "address",
+    "geocoding",
+    "gnaf"
+  ]
+}

package/src/server.mjs

@@ -0,0 +1,89 @@
+import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
+import { StdioServerTransport } from '@modelcontextprotocol/sdk/server/stdio.js';
+import { z } from 'zod';
+
+const API_HOST = process.env.RAPIDAPI_HOST || 'addressr.p.rapidapi.com';
+const API_BASE = `https://${API_HOST}`;
+
+async function apiCall(path, key) {
+  const response = await fetch(`${API_BASE}${path}`, {
+    headers: {
+      'x-rapidapi-key': key,
+      'x-rapidapi-host': API_HOST,
+    },
+  });
+  if (!response.ok) {
+    throw new Error(`API error: ${response.status} ${response.statusText}`);
+  }
+  return response.json();
+}
+
+export function createServer() {
+  const key = process.env.RAPIDAPI_KEY;
+  if (!key) {
+    console.error(
+      'RAPIDAPI_KEY environment variable is required. Get one at https://rapidapi.com/addressr-addressr-default/api/addressr',
+    );
+    process.exit(1);
+  }
+
+  const server = new McpServer({
+    name: 'addressr',
+    version: '0.1.0',
+  });
+
+  server.tool(
+    'search-addresses',
+    'Search Australian addresses by street, suburb, or postcode. Returns up to 8 results per page with standard address format, relevance score, and property ID (PID). Data sourced from the Geocoded National Address File (G-NAF).',
+    {
+      q: z
+        .string()
+        .describe(
+          'Australian address search query (min 3 chars). e.g. "1 george st sydney", "2000", "pyrmont nsw"',
+        ),
+      page: z
+        .number()
+        .optional()
+        .describe('Page number for paginated results (default: first page)'),
+    },
+    async ({ q, page }) => {
+      const params = new URLSearchParams({ q });
+      if (page !== undefined) params.set('page', String(page));
+      const data = await apiCall(`/addresses?${params}`, key);
+      return { content: [{ type: 'text', text: JSON.stringify(data, null, 2) }] };
+    },
+  );
+
+  server.tool(
+    'get-address',
+    'Get full address details by property ID (PID). Returns geocoding (lat/long), structured components (street, suburb, state, postcode, unit/flat), and confidence score. PIDs are obtained from search results.',
+    {
+      addressId: z
+        .string()
+        .describe(
+          "G-NAF Property ID (PID), e.g. 'GANSW710280564'. Obtained from search results.",
+        ),
+    },
+    async ({ addressId }) => {
+      const data = await apiCall(`/addresses/${encodeURIComponent(addressId)}`, key);
+      return { content: [{ type: 'text', text: JSON.stringify(data, null, 2) }] };
+    },
+  );
+
+  server.tool(
+    'health',
+    'Check API service status. Returns version, timestamp, and health status.',
+    {},
+    async () => {
+      const data = await apiCall('/health', key);
+      return { content: [{ type: 'text', text: JSON.stringify(data, null, 2) }] };
+    },
+  );
+
+  return server;
+}
+
+// Start server when run directly
+const server = createServer();
+const transport = new StdioServerTransport();
+await server.connect(transport);