Skip to main content

MCP server for the ATTOM Real Estate API

Project description

ATTOM API MCP Server

An MCP server for the ATTOM API, providing real estate data via the MCP protocol. This server acts as middleware, exposing the ATTOM API endpoints as MCP tools that can be used by AI agents.

Features

  • MCP interface for ATTOM API endpoints
  • Comprehensive API coverage for property data, valuations, assessments, and sales
  • Structured error handling and logging
  • Configurable via environment variables
  • Packaged as a Python CLI tool for easy deployment

Prerequisites

  • Python 3.11 or higher
  • uv for dependency management
  • An ATTOM API key

Installation

Using UVX (Recommended)

The easiest way to install and run the ATTOM API MCP Server is via uvx:

uvx mcp-server-attom --help

This will download and run the tool directly without requiring a permanent installation.

To install it permanently:

uv tool install mcp-server-attom

Local Development

  1. Clone this repository:
git clone https://github.com/nkbud/mcp-server-attom.git
cd mcp-server-attom
  1. Install dependencies:
uv sync --locked --all-extras --dev
  1. Create a .env file with your ATTOM API key:
cp .env.example .env
# Edit .env and add your ATTOM API key

Usage

MCP Client Integration

For detailed instructions on using this server with various MCP clients (Claude Desktop, mcp-inspector, mcp-cli) and stdio communication, see the Client Integration Guide.

Quick Start Examples:

# With Claude Desktop - add to configuration file
{
  "mcpServers": {
    "attom-api": {
      "command": "uvx",
      "args": ["mcp-server-attom"],
      "env": {"ATTOM_API_KEY": "your_api_key_here"}
    }
  }
}

# With MCP Inspector
npx @modelcontextprotocol/inspector uvx mcp-server-attom

# With MCP CLI
mcp list tools uvx mcp-server-attom
mcp call uvx mcp-server-attom property_detail '{"attom_id": "145423726"}'

# Direct stdio communication
export ATTOM_API_KEY=your_api_key_here
uvx mcp-server-attom

Running as a CLI Tool

Start the server using the mcp-server-attom command:

# If installed via uv tool install
mcp-server-attom --port 8000 --host 0.0.0.0

# Or run directly via uvx
uvx mcp-server-attom --port 8000 --host 0.0.0.0

Available command-line options:

  • --host: Host to bind the server to (default: 0.0.0.0)
  • --port: Port to bind the server to (default: 8000)
  • --log-level: Logging level (debug, info, warning, error)
  • --reload: Enable auto-reload on code changes

Running Locally During Development

Start the server during development:

python -m src.server

This will start the server using stdio transport for MCP communication.

Making Requests

The server exposes MCP tools for various ATTOM API endpoints. Here's an example of using the property_detail tool:

await mcp.tools.property_detail(
    attom_id="145423726"  # OR
    # address="123 Main St, New York, NY 10001"  # OR
    # address1="123 Main St", address2="New York, NY 10001"  # OR
    # fips="36061", apn="12345"
)

Configuration

The server can be configured using the following environment variables:

Variable Description Required Default
ATTOM_API_KEY Your ATTOM API key Yes -
ATTOM_HOST_URL Base URL for the ATTOM API No https://api.gateway.attomdata.com
ATTOM_PROP_API_PREFIX Prefix for property API endpoints No /propertyapi/v1.0.0
ATTOM_DLP_V2_PREFIX Prefix for DLP v2 API endpoints No /property/v2
ATTOM_DLP_V3_PREFIX Prefix for DLP v3 API endpoints No /property/v3
LOG_LEVEL Logging level (DEBUG, INFO, WARNING, ERROR) No INFO
LOG_FORMAT Log format (json or console) No json

Available Tools

Property Tools

  • property_address: Get property address information
  • property_detail: Get detailed property information
  • property_basic_profile: Get basic property profile information
  • property_expanded_profile: Get expanded property profile information
  • property_detail_with_schools: Get property details including school information

Assessment Tools

  • assessment_detail: Get detailed assessment information
  • assessment_snapshot: Get assessment snapshot
  • assessment_history_detail: Get assessment history

Sale Tools

  • sale_detail: Get detailed sales information
  • sale_snapshot: Get sales snapshot
  • sales_history_detail: Get sales history
  • sales_history_snapshot: Get sales history snapshot

Valuation Tools

  • avm_detail: Get detailed AVM information
  • avm_snapshot: Get AVM snapshot
  • avm_history_detail: Get AVM history
  • attom_avm_detail: Get ATTOM AVM information
  • home_equity: Get home equity information
  • rental_avm: Get rental AVM information

Development

Running Tests

uv run pytest

Linting

uv run ruff check .
uv run black .
uv run isort .

Building and Publishing

To build and publish the package to PyPI:

  1. Ensure you have the latest version of uv:
pip install -U uv
  1. Set up a PyPI token:

    • Create an account on PyPI if you don't have one
    • Go to Account Settings > API Tokens
    • Create a token with scope restricted to the mcp-server-attom project
    • Save the token securely
  2. Build the package:

uv build --no-sources
  1. Publish the package using your PyPI token:
uv publish --token YOUR_PYPI_TOKEN

Alternatively, you can store your token in a .pypirc file or as an environment variable:

export PYPI_TOKEN=YOUR_PYPI_TOKEN
uv publish

License

MIT

Support

For issues with this MCP server, please open an issue on the GitHub repository.

For issues with the ATTOM API itself, please contact ATTOM Data Solutions support.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mcp_server_attom-0.0.11.tar.gz (340.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mcp_server_attom-0.0.11-py3-none-any.whl (17.6 kB view details)

Uploaded Python 3

File details

Details for the file mcp_server_attom-0.0.11.tar.gz.

File metadata

  • Download URL: mcp_server_attom-0.0.11.tar.gz
  • Upload date:
  • Size: 340.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.12

File hashes

Hashes for mcp_server_attom-0.0.11.tar.gz
Algorithm Hash digest
SHA256 b40220ac83a4747a5938347fcab85632989f136e0465d692350c15fe7d241524
MD5 d558653439b8aa0f5620396538cd91c0
BLAKE2b-256 93695d1975880972af8dbad7e74f57c8cc4344fca298f8982f338ae0b6c44bbb

See more details on using hashes here.

File details

Details for the file mcp_server_attom-0.0.11-py3-none-any.whl.

File metadata

File hashes

Hashes for mcp_server_attom-0.0.11-py3-none-any.whl
Algorithm Hash digest
SHA256 b0668b8ee315abbdff85c0210a734a0dc4bb7b3a602782f3704476dc17115e93
MD5 ecc730b6c4956d639960151a62467fc4
BLAKE2b-256 32d32f40743283dc3000cd5833e80670c21236f6c1d316fd0cf5d983fa1d6ce2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page