The official IPGeolocation.io MCP server provides tools for accurate IP geolocation, company information, ASN and network data, IP security (VPN, proxy, Tor, bot, hosting and spam detection), abuse contacts, time zones, astronomy, currency data and user-agent parsing.
MCP (Model Context Protocol) lets your assistant use these tools. Connect to our hosted server, or run the server on your computer.
Published version: 2.0.3.
The local install commands follow npm's latest tag, including future major releases. Restart your local MCP server to load an update. Source and Docker installations need a rebuild.
The table below describes the published local package.
| Item | Value |
|---|---|
| Package | ipgeolocation-io-mcp |
| Version | 2.0.3 |
| Release date | 2026-11-05 |
| Transport | stdio |
| Node.js | >=22 |
Use our hosted server without installing or running an MCP server on your computer. Your client must support Streamable HTTP and private custom headers.
- Use your existing IPGeolocation.io API key, or create a free one.
- Add a remote MCP connection with these settings:
| Setting | Value |
|---|---|
| Server URL | https://mcp.ipgeolocation.io/mcp |
| Connection type | Streamable HTTP |
| Header name | X-IPGeolocation-API-Key |
| Header value | <YOUR_API_KEY> |
- Save the connection and ask: "Where is 8.8.8.8 located?"
Replace <YOUR_API_KEY> with your key in your client's private settings. Keep the key out of chat messages, URLs and shared files.
Your existing free or paid plan and API credit rules apply.
Hosted MCP provides 16 tools. get_my_ip is available only locally because a hosted server would return its own IP address. For IP lookups, include the IP you want to check.
See the hosted guide for connection details and instructions for running your own hosted server.
- Create a free IPGeolocation.io API key.
- Merge this entry into your client's private configuration, keeping any existing servers. See Install by Client for the configuration location. Cursor also has a one-click installer.
{
"mcpServers": {
"ipgeolocation": {
"command": "npx",
"args": ["-y", "ipgeolocation-io-mcp@latest"],
"env": {
"IPGEOLOCATION_API_KEY": "<YOUR_API_KEY>"
}
}
}
}- Reload the server or restart your client.
- Ask "Where is 8.8.8.8 located?"
- Hosted MCP
- Quick Start
- Install by Client
- Verify It Works
- Tools by Plan
- Tool Reference
- Prompt Examples
- Example Answers and Tool Output
- Error Codes
- How It Works
- Caching
- Cached Result Pagination
- Environment Variables
- Building from Source
- Docker
- Testing
- Troubleshooting
- Pricing
- Links
- License
- Privacy Policy
The following instructions run MCP on your computer. To connect to our hosted service, see Hosted MCP.
- Node.js 22 or later for npm/source installs, or a bundle host with a compatible Node.js runtime
npxavailable for the npm configuration examples- An IPGeolocation.io API key for most API tools
Use a supported Node.js release with its latest security updates.
get_my_ip requires no API key. The other 15 API tools require one. get_cached_result reads results already held in memory; use the same API key as the original lookup.
Sign up for a free IPGeolocation.io API key
Use a private user configuration or your client's secret/environment settings for the real key. Keep keys out of committed project configuration. Each client below uses the Quick Start server entry unless its format differs.
Set IPGEOLOCATION_API_KEY in your private shell environment before running these commands. The variable reference keeps the key value out of the command you type and its shell history.
codex mcp add ipgeolocation --env "IPGEOLOCATION_API_KEY=$IPGEOLOCATION_API_KEY" -- npx -y ipgeolocation-io-mcp@latest
codex mcp listStart a new Codex session after adding the server.
Install the published server from its Claude Marketplace listing. In Claude Desktop, open Settings > Extensions > Browse extensions, find IPGeolocation.io MCP Server, and configure your API key during installation. See Anthropic's desktop extension guide. The directory distributes the approved published bundle; its refresh can lag GitHub Releases. Check the installed version, or download the versioned bundle below.
For manual npm configuration, open Settings > Developer > Edit Config in Claude Desktop. This opens claude_desktop_config.json:
- macOS:
~/Library/Application Support/Claude/claude_desktop_config.json - Windows:
%APPDATA%\Claude\claude_desktop_config.json
Merge the Quick Start entry into mcpServers.
Fully quit and reopen Claude Desktop after saving. See the official local-server setup guide.
For clients that install MCP Bundles, download the published v2.0.3 .mcpb bundle from GitHub Releases. The bundle contains the server and its dependencies; its host still needs a Node.js 22+ runtime. Enter your API key when the host prompts for bundle configuration.
In Cline, open MCP Servers > Configure > Configure MCP Servers. Add the Quick Start entry under mcpServers in the settings JSON. Cline CLI uses ~/.cline/data/settings/cline_mcp_settings.json by default. See Cline's MCP guide.
Restart Cline after saving.
One-click install:
Or add to .cursor/mcp.json for this project, or ~/.cursor/mcp.json for all projects. See Cursor's MCP guide.
{
"mcpServers": {
"ipgeolocation": {
"type": "stdio",
"command": "npx",
"args": ["-y", "ipgeolocation-io-mcp@latest"],
"env": {
"IPGEOLOCATION_API_KEY": "<YOUR_API_KEY>"
}
}
}
}Restart Cursor after saving.
The ipgeolocation-io-mcp repository includes a Cursor plugin for ipgeolocation-io-mcp. The plugin runs locally over stdio and requires Node.js 22 or later.
To install it locally, clone that repository into a new directory under ~/.cursor/plugins/local/, reload Cursor, and open Customize > Plugins.
- Local plugin: set
IPGEOLOCATION_API_KEYin the environment that launches Cursor. The plugin reads the key from that environment. - Marketplace install: set the key in the plugin's private configuration.
With an empty or unset API key, get_my_ip still works. API tools that require a key return a missing-key error without sending a request.
To load a local checkout in Cursor CLI:
agent --plugin-dir /absolute/path/to/ipgeolocation-io-mcpAPI requests that need a key use your account's plan and credits. The get_cached_result tool reads saved response pages without making another API request.
Install this server by only one method, because using more than one creates duplicate tool entries. You can keep any other servers in your existing configuration.
In Cascade's ... (Actions) menu, choose Open MCP config file in the MCPs section. Merge the Quick Start entry into the file opened by your installed version; configuration paths vary by release. See the vendor's Cascade MCP guide for the active agent and configuration location in newer releases.
Save the file and reload the server in the client.
The Kiro Power provides 17 tools for IP geolocation, company information, ASN and network data, IP security (VPN, proxy, Tor, bot, hosting and spam detection), abuse contacts, time zones, astronomy, currency data and user-agent parsing. It runs ipgeolocation-io-mcp locally over stdio, follows npm's latest tag and requires Node.js 22 or later. Import the packaging/kiro folder through Powers > Add Custom Power and follow the setup guide to configure your private API key. Most tools require a key; access and credits depend on your plan.
Run MCP: Add Server from the Command Palette, choose a local command, and use npx -y ipgeolocation-io-mcp@latest. Choose Copilot Global for private user settings or .mcp.json for a portable workspace configuration. Add IPGEOLOCATION_API_KEY to the server's environment.
The portable .mcp.json format uses the top-level mcpServers object shown in Quick Start.
Use the server's Start action and approve its configuration when prompted. Existing .vscode/mcp.json files use a top-level servers object instead. See VS Code's MCP setup guide.
You can try the server on Glama directly. Only IPGEOLOCATION_API_KEY is required. Leave other environment variable fields empty unless you want to change cache, timeout, or output limits.
If you don't have a key yet, create a free IPGeolocation.io API key.
For local MCP, use the ipgeolocation entry from Quick Start in your client's configuration format. The client must support launching a local stdio process. To connect to our hosted service, follow Hosted MCP.
Try these after setup:
| Prompt | Expected tool |
|---|---|
| Where is 8.8.8.8 located? | lookup_ip |
| For IP 49.12.212.42, give me threat indicators, company, ASN, and city. | lookup_ip with fields and include=security |
| Show threat indicators and the abuse contact email for 2.56.12.11. | lookup_ip with include=security,abuse |
| For AS1, list upstream ASN numbers only. | lookup_asn with include=upstreams |
| Convert 2026-03-07 09:30 from New York to Tokyo time. | convert_timezone |
| Give sunrise times for Karachi from 2026-03-10 to 2026-03-15. | get_astronomy_time_series |
| Parse this user agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/122.0.0.0 Safari/537.36 | parse_user_agent |
Local MCP provides 17 tools. Hosted MCP provides 16 and does not include get_my_ip. Both follow your IPGeolocation.io plan and credit rules. Bulk tools accept 250 inputs by default; the effective ceiling is the lower of the two item-limit settings.
Listed costs apply to successful upstream requests. Cache hits and cached-page reads use no additional credits. The API's X-Credits-Charged response header establishes actual billing; see the credit rules.
The free plan provides 1,000 API credits per day. The following tools provide their core data on Free; get_cached_result also reads saved pages for 0 credits. get_my_ip is available only locally.
| Tool | Credits | What it does |
|---|---|---|
lookup_ip |
1 | Location, time zone, currency, ASN for one IP |
get_my_ip |
0 | Public IP of the machine running the server |
lookup_currency |
1 | Currency and country metadata for one IP |
get_timezone |
1 | Time zone by name, location, IP, airport code, or UN/LOCODE |
convert_timezone |
1 | Convert time between two locations |
get_astronomy |
1 | Sunrise, sunset, moonrise, moonset, twilight, moon phase for one date |
get_astronomy_time_series |
1 | Daily astronomy data for a date range (up to 90 days) |
Company details, network data, security, abuse contacts and bulk geolocation require a paid plan. lookup_company can return basic ASN ownership on Free, but not company details. On Free, include=* returns base IP data only; it does not unlock paid features. See the API plan documentation for current access rules.
All 17 tools are available locally, or 16 through hosted MCP, including the zero-credit cached result reader. Paid plans also add network, company, and extended asn fields to lookup_ip, plus the include parameter for security, abuse, hostname, liveHostname, hostnameFallbackLive, user_agent, geo_accuracy, dma_code, or *.
| Tool | Credits | What it does |
|---|---|---|
bulk_lookup_ip |
1 per IP | Batch geolocation, 250 inputs by default |
check_security |
2 | VPN, proxy, Tor, bot, spam, and threat flags |
bulk_security_check |
2 per IP | Batch threat checks |
lookup_company |
1 | Company name and ASN holder for one IP |
lookup_network |
1 | Route prefix, connection type, anycast status |
parse_user_agent |
1 | Parse one UA string into browser, device, OS, engine |
bulk_parse_user_agent |
1 per UA | Batch UA parsing, 250 strings by default |
lookup_asn |
1 | ASN details, peers, upstreams, downstreams, routes, WHOIS |
get_abuse_contact |
1 | Abuse contact emails, phone, address, route |
Credit math for lookup_ip with include:
| Combination | Total credits |
|---|---|
| Base lookup | 1 |
include=security |
3 |
include=abuse |
2 |
include=* (Paid, unfiltered) |
4 |
include=* (Free, base only) |
1 |
include=security&fields=security |
2 |
include=abuse&fields=abuse |
1 |
For current plan details and pricing, see the IPGeolocation.io pricing page.
The full reference lists parameters and response formats. The tools below are available locally; hosted MCP provides the same tools except get_my_ip.
IP location, company information, ASN and network data, with optional security and abuse details. Parameters.
IP lookups in batches of up to 250 by default. Parameters.
Available only when running MCP locally. Returns the public IP of the machine running the server. No API key or credits needed. Parameters.
VPN, proxy, Tor, bot, hosting, spam and other threat indicators for an IP. Parameters.
Security checks for a batch of IPs. Parameters.
Current local time and time zone details for a place. Parameters.
Time conversion between two places. Parameters.
Sun and moon data for one place and date. Parameters.
Daily astronomy data for a date range of up to 90 days. Parameters.
Browser, operating system and device details from a supplied user-agent string. Parameters.
User-agent parsing for a batch of supplied strings. Parameters.
Company information and ASN ownership for an IP. Company details require a paid plan. Parameters.
Currency and country metadata for an IP. Parameters.
Route prefix, connection type and anycast status for an IP. Parameters.
ASN details, network relationships, routes and WHOIS data. Parameters.
Abuse reporting contacts for an IP. Parameters.
Remaining pages of a saved result, without another API call or additional credits. Parameters.
Ask for the information you need in your own words. Available data and credit use depend on your plan.
IP location is an estimate. Threat scores and VPN/proxy flags are signals to investigate, not a guarantee that traffic is safe or harmful. Missing or unknown values do not mean false.
- Show the threat indicators and city for 49.12.212.42 so I can assess it against our network policy.
- Check these IPs for VPN, proxy, Tor, bot, and spam indicators: 49.12.212.42, 2.56.12.11, 8.8.8.8
- For 49.12.212.42, tell me the threat score, whether it is a cloud provider, and whether it looks like a relay.
- Who uses 1.1.1.1 and which ASN routes it?
- For AS24940, list upstream ASN numbers only.
- Is this IP anycast and what route prefix is announced for it: 1.1.1.1
- For IP 2.56.12.11, give me the abuse contact email, phone number, and organization.
- I need the abuse contact for 1.0.0.0 and the network route involved.
- For this IP, show me the abuse contact details only: 1.1.1.1
- What time is it in Tokyo right now?
- Convert 2026-03-07 09:30 from New York to Tokyo time.
- What is the current local time at JFK airport?
- Give sunrise and sunset for London on 2026-06-21.
- Show sunrise times in Karachi from 2026-03-10 to 2026-03-15.
- For New York, give me moon phase and day length on 2026-07-17.
- Parse this user agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_2) AppleWebKit/601.3.9 (KHTML, like Gecko) Version/9.0.2 Safari/601.3.9
- Parse these user agents in bulk and tell me the browser, OS, and device type for each.
- Does this user agent look like a crawler or bot? Mozilla/5.0 (Linux; Android 6.0.1; Nexus 5X Build/MMB29P) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2272.96 Mobile Safari/537.36 (compatible; Googlebot/2.1; +http://www.google.com/bot.html)
The examples illustrate the format; lookup data can change.
See the IP lookup example.
See the time conversion example.
See the abuse contact example.
Errors explain what failed and suggest a next step. Start with Troubleshooting for common problems, or see the error reference when handling errors in code.
A failed or canceled request may already have used API credits. Check the error guidance before retrying. For bulk results, retry only eligible failed inputs; successful inputs do not need another lookup.
Your MCP client connects to our hosted server or starts the server on your computer. The server checks each request, then returns a cached result or calls the IPGeolocation.io API.
Lookups send the requested inputs to IPGeolocation.io. Cached results stay in memory; your client or host controls its own configuration and logs. See the Security Policy for data handling.
When running locally, tools that allow an omitted IP use the server machine's public IP. That can differ from your own IP. Hosted MCP requires an explicit lookup target, such as an IP address, place or ASN. Security tools return IP intelligence; they do not run the separate browser-based Real-Time Proxy & VPN Detection service.
Most lookup results are cached for five minutes by default. Reusing a cached result costs no additional API credits. Current-time tools (get_timezone, convert_timezone, get_astronomy) and get_my_ip always call the API.
Saved pages remain available for five minutes after the last successful page read by default. Cached data can also disappear when the cache fills or the server restarts. Reading an unavailable page costs no credits, but repeating the original lookup can use credits again.
force_refresh: true requests fresh data and can use credits. See the cache reference for expiry, shared results and refresh rules.
For local MCP, set IPGEOLOCATION_API_KEY in your client's private server settings. Leave optional settings unset unless you need to change the defaults. To connect to our hosted service, use the Hosted MCP connection settings.
| Setting | Default | Purpose |
|---|---|---|
IPGEOLOCATION_API_KEY |
Not set | Your API key; required for all API tools except get_my_ip. |
IPGEOLOCATION_REQUEST_TIMEOUT_MS |
15000 (15 seconds) |
How long to wait for an API response. |
IPGEOLOCATION_MCP_CACHE_TTL_MS |
300000 (5 minutes) |
How long to keep lookup results and idle result pages. |
The configuration reference lists all settings, limits and allowed values. Larger limits can require more memory.
Large results can arrive in pages. The get_cached_result tool reads the remaining pages without another API call or additional credits. It also costs nothing if a page is unavailable.
Keep the same server process and API key while reading pages. Saved pages expire after five minutes without a successful read by default, and the cache can remove them sooner if it fills. If the full result is too large to save, the lookup returns an error without a page cursor; the API may already have used credits.
For client developers, the pagination reference explains the page fields and includes a complete retrieval example.
See Building from Source for build commands and MCP Inspector setup. Source installations run the code in your checkout, including any unreleased changes.
docker build -t ipgeolocation-mcp .
docker run --rm -i -e IPGEOLOCATION_API_KEY ipgeolocation-mcpSet IPGEOLOCATION_API_KEY in your private shell environment first. The image includes Node.js and runs as the unprivileged node user. Docker's -i flag keeps stdin open for MCP messages. Omit -t so the protocol uses ordinary stdin/stdout.
Rebuild the image when you update the source or need a newer runtime.
After building the image, configure a local-command MCP client with:
{
"mcpServers": {
"ipgeolocation": {
"command": "docker",
"args": ["run", "--rm", "-i", "-e", "IPGEOLOCATION_API_KEY", "ipgeolocation-mcp"],
"env": {
"IPGEOLOCATION_API_KEY": "<YOUR_API_KEY>"
}
}
}
}See Testing for the offline suite and separate live API checks. Live checks can use credits.
Instructions to restart the server or change environment variables apply when you run the server yourself. For our hosted service, use the connection settings in your client.
Client uses an old tool after updating: Restart the server process and check its version in your client's MCP connection details. Compare it with the latest npm version. Rebuild source and Docker installations before restarting them.
API key not configured: For local MCP, set IPGEOLOCATION_API_KEY in your client's private server configuration. For hosted MCP, add the X-IPGeolocation-API-Key header in your client's private connection settings. A missing key is rejected before an API lookup.
401 errors: The API rejected the key or requested capability. Check that the key is active and the plan supports the tool. Domain lookups in lookup_ip also require a paid plan.
423 errors: Use a public routable IP. Private/bogon addresses such as 10.0.0.1 and reserved documentation addresses such as 203.0.113.42 cannot be used as successful geolocation examples.
Network requires a proxy: See the proxy setup instructions for supported Node.js versions and settings.
Timeout: Check the connection and the error guidance before retrying; the API may already have used credits. If requests need longer, adjust IPGEOLOCATION_REQUEST_TIMEOUT_MS within the allowed range.
Redirect blocked: The server received an unexpected HTTP redirect and stopped before forwarding credentials or request data. Do not retry automatically. Investigate the API endpoint or contact support with the sanitized error.
Cached result unavailable: The cursor belongs to another key or process, or the snapshot expired or was evicted. The failed page read made no API call. A new lookup can consume credits.
Resource limit: Check the error's guidance before trying again. The server rejects oversized tool arguments before making an API request. A response can exceed a limit after the API has used credits. Another lookup can use more credits. Reducing displayed fields does not always reduce the API response size. If you received a page cursor, use get_cached_result to read the remaining data without another API request. Raise limits only when the server has enough memory.
Client asks for an MCP URL: Use the hosted connection. Your client must support Streamable HTTP and private custom headers.
For current plan details, credits, and pricing, see the IPGeolocation.io pricing page.
- IPGeolocation.io Website
- IPGeolocation.io API Documentation
- IPGeolocation.io Pricing
- Create a Free IPGeolocation.io API Key
- Tool and Configuration Reference
- Hosted MCP Guide
- Changelog
- Security Policy
- Contributing
- Release Checklist
API lookups send the requested inputs to IPGeolocation.io, which also receives the server machine's public egress IP. The server caches results in process memory. Your MCP client or hosting provider controls its own configuration and log storage. See the Security Policy for retention details and the IPGeolocation.io Privacy Policy for provider handling.