setup-codex-cli.md

Connect with Codex CLI

This page describes how to connect the real estate MCP server to Codex CLI.

Prerequisites

• Codex CLI (npm install -g @openai/codex)
• uv
• API key from 공공데이터포털

Option 1: stdio (recommended)

The server runs as a child process of Codex CLI. No separate server process is needed.

1. Clone this repository locally.

   git clone <repository_url>
   cd real-estate-mcp

2. Register this MCP server in Codex CLI.

   codex mcp add real-estate \
     --env DATA_GO_KR_API_KEY=your_api_key_here \
     -- uv run --directory /path/to/real-estate-mcp \
     python src/real_estate/mcp_server/server.py

   Replace /path/to/real-estate-mcp with the actual path to your cloned repository.

   If you want separate keys per service, add more --env options:

   codex mcp add real-estate \
     --env DATA_GO_KR_API_KEY=... \
     --env ODCLOUD_API_KEY=... \
     --env ODCLOUD_SERVICE_KEY=... \
     --env ONBID_API_KEY=... \
     -- uv run --directory /path/to/real-estate-mcp \
     python src/real_estate/mcp_server/server.py

3. Verify that the server is registered.

   codex mcp list
   codex mcp get real-estate

4. For better responses in Codex CLI, create an AGENTS.md file in your working project root and paste resources/custom-instructions-ko.md into it.

   In Codex CLI, use AGENTS.md (project root) instead of Claude Desktop's Project Instructions tab.

Option 2: HTTP (streamable-http)

The server runs as a standalone HTTP process. Use this when you want to share one running server instance across multiple clients.

1. Clone this repository locally.

   git clone <repository_url>
   cd real-estate-mcp

2. Create a .env file in the project root (the server reads it on startup).

   cp .env.example .env

   Set your API key:

   DATA_GO_KR_API_KEY=your_api_key_here
   

3. Start the server.

   uv run real-estate-mcp --transport http

   By default this binds to http://127.0.0.1:8000. To change host or port:

   uv run real-estate-mcp --transport http --host 0.0.0.0 --port 9000

4. Register the server in Codex CLI using the HTTP URL.

   codex mcp add real-estate --url http://127.0.0.1:8000/mcp

5. Verify that the server is registered.

   codex mcp list
   codex mcp get real-estate

Remove

codex mcp remove real-estate