| 1 | # Korea Real Estate MCP |
| 2 | |
| 3 | [English](README.md) | [한국어](README-ko.md) |
| 4 | |
| 5 | Connect Claude to Korea's MOLIT real estate API and simulate **buy now / buy later / invest only** scenarios based on your income, savings, and retirement goals. |
| 6 | Provides 14+ tools for live transaction data and financial calculations — apartment, officetel, villa, single-house, and commercial. |
| 7 | |
| 8 | ## Supported Tools |
| 9 | |
| 10 | - [x] Apartment trade / rent (`get_apartment_trades`, `get_apartment_rent`) |
| 11 | - [x] Officetel trade / rent (`get_officetel_trades`, `get_officetel_rent`) |
| 12 | - [x] Villa / multi-family housing trade / rent (`get_villa_trades`, `get_villa_rent`) |
| 13 | - [x] Single-house / multi-household trade / rent (`get_single_house_trades`, `get_single_house_rent`) |
| 14 | - [x] Commercial building trades (`get_commercial_trade`) |
| 15 | - [x] Apartment subscription notices / results (`get_apt_subscription_info`, `get_apt_subscription_results`) |
| 16 | - [x] Region code lookup (`get_region_code`) |
| 17 | |
| 18 | ## Prerequisites |
| 19 | |
| 20 | - [uv](https://docs.astral.sh/uv/getting-started/installation/) |
| 21 | - API key from [공공데이터포털](https://www.data.go.kr) — apply for the services below: |
| 22 | - [국토교통부\_아파트 매매 실거래가 자료](https://www.data.go.kr/data/15126469/openapi.do) |
| 23 | - [국토교통부\_아파트 전월세 자료](https://www.data.go.kr/data/15126474/openapi.do) |
| 24 | - [국토교통부\_오피스텔 매매 신고 자료](https://www.data.go.kr/data/15126464/openapi.do) |
| 25 | - [국토교통부\_오피스텔 전월세 자료](https://www.data.go.kr/data/15126475/openapi.do) |
| 26 | - [국토교통부\_연립다세대 매매 실거래가 자료](https://www.data.go.kr/data/15126467/openapi.do) |
| 27 | - [국토교통부\_연립다세대 전월세 실거래가 자료](https://www.data.go.kr/data/15126473/openapi.do) |
| 28 | - [국토교통부\_단독/다가구 매매 실거래가 자료](https://www.data.go.kr/data/15126465/openapi.do) |
| 29 | - [국토교통부\_단독/다가구 전월세 자료](https://www.data.go.kr/data/15126472/openapi.do) |
| 30 | - [국토교통부\_상업업무용 부동산 매매 신고 자료](https://www.data.go.kr/data/15126463/openapi.do) |
| 31 | - [한국부동산원_청약홈_APT 분양정보](https://www.data.go.kr/data/15101046/fileData.do) |
| 32 | - [한국부동산원_청약홈 청약 신청·당첨자 정보 조회 서비스](https://www.data.go.kr/data/15110812/openapi.do) |
| 33 | |
| 34 | > For parsing API specs in hwp or docx format, see [Common Utils Guide](docs/guide-common-utils.md) |
| 35 | |
| 36 | ## Quick Start: Claude Desktop (stdio) |
| 37 | |
| 38 | The fastest way to get started — the server runs as a child process of Claude Desktop. |
| 39 | |
| 40 | 1. Clone this repository locally. |
| 41 | |
| 42 | ```bash |
| 43 | git clone <repository_url> |
| 44 | cd real-estate-mcp |
| 45 | ``` |
| 46 | |
| 47 | 1. Open the Claude Desktop config file. |
| 48 | |
| 49 | ```bash |
| 50 | # macOS |
| 51 | open "$HOME/Library/Application Support/Claude/claude_desktop_config.json" |
| 52 | ``` |
| 53 | |
| 54 | ```powershell |
| 55 | # Windows |
| 56 | notepad %APPDATA%\Claude\claude_desktop_config.json |
| 57 | ``` |
| 58 | |
| 59 | 1. Add the entry below under `mcpServers`. |
| 60 | |
| 61 | ```json |
| 62 | { |
| 63 | "mcpServers": { |
| 64 | "real-estate": { |
| 65 | "command": "uv", |
| 66 | "args": [ |
| 67 | "run", |
| 68 | "--directory", "/path/to/real-estate-mcp", |
| 69 | "python", "src/real_estate/mcp_server/server.py" |
| 70 | ], |
| 71 | "env": { |
| 72 | "DATA_GO_KR_API_KEY": "your_api_key_here" |
| 73 | } |
| 74 | } |
| 75 | } |
| 76 | } |
| 77 | ``` |
| 78 | |
| 79 | 1. Restart Claude Desktop. |
| 80 | Setup is complete when you can see the `real-estate` server in the tool list. |
| 81 | |
| 82 | 1. For better responses, create a **Project** in Claude Desktop and paste [resources/custom-instructions-ko.md](resources/custom-instructions-ko.md) into the **Project Instructions** tab. |
| 83 | |
| 84 | ## Connect with Other Clients |
| 85 | |
| 86 | For other clients, transport options, or per-service API key configuration, see the docs below. |
| 87 | |
| 88 | | Guide | Transport | Clients | |
| 89 | |-------|-----------|---------| |
| 90 | | [docs/setup-prerequisites.md](docs/setup-prerequisites.md) | — | All clients | |
| 91 | | [docs/setup-with-stdio.md](docs/setup-with-stdio.md) | stdio / local HTTP | Claude Desktop, Claude CLI, Codex CLI | |
| 92 | | [docs/setup-with-http.md](docs/setup-with-http.md) | HTTP (remote) | Claude (web), Claude CLI, Codex CLI | |
| 93 | | [docs/setup-reverse-proxy.md](docs/setup-reverse-proxy.md) | — | Server-side proxy setup (Cloudflare Tunnel) | |
| 94 | |
| 95 | ## Contributors |
| 96 | |
| 97 | This project exists thanks to all the people who contribute. [[Contributing](https://github.com/ta |