Mylocation MCP

🚀 MCP Server TypeScript Starter Project

This project is a Location Service Server implementation based on the Model Context Protocol (MCP). It demonstrates how to build an MCP server using TypeScript and provides practical functionality for location queries via coordinates or IP addresses.

🚀 Quick Start

This project offers a TypeScript-based MCP server implementation, enabling location queries through coordinates or IP addresses.

✨ Features

• TypeScript configuration
• Complete MCP server setup
• Location service implementation
  • Geolocation lookup based on coordinates
  • Location lookup based on IP (using IPInfo.io)
  • Health check endpoint
• Type-safe development environment
• External API integration

📦 Installation

npm install mylocation-mcp

💻 Usage Examples

Basic Usage

1. Create a .env file and add your IPInfo.io API token:

IPINFO_TOKEN=your_ipinfo_token_here

2. Import and use in your code:

import { McpServer } from 'mylocation-mcp';

Advanced Usage

If you want to modify or contribute to the project:

# Clone the repository
git clone https://github.com/yhwancha/mylocation-mcp.git
cd mylocation-mcp

# Install dependencies
npm install

# Set up environment variables
cp .env.example .env
# Edit .env and add your IPInfo.io API token

# Build the project
npm run build

📚 Documentation

Project Structure

.
├── src/
│   └── index.ts    # Main server implementation file, including location tools
├── build/           # Compiled JavaScript files
├── package.json    # Project dependencies and scripts
├── tsconfig.json   # TypeScript configuration
├── .env.example    # Environment variable template
└── README.md      # Documentation

Implemented Tools

Basic Usage

server.tool(
  "get-location-by-coordinates",
  "Get geographical location information from the provided coordinates",
  {
    latitude: z.string().describe("Latitude coordinate (between -90 and 90)"),
    longitude: z.string().describe("Longitude coordinate (between -180 and 180)")
  },
  async ({ latitude, longitude }) => {
    // Implementation details...
  }
);

Advanced Usage

server.tool(
  "get-location-by-ip",
  "Get geographical location information from an IP address",
  {
    ipAddress: z.string().describe("The IP address to query")
  },
  async ({ ipAddress }) => {
    // Implementation details...
  }
);

server.tool(
  "health",
  "Check the health status of the service",
  {},
  async () => {
    // Implementation details...
  }
);

MCP Server Configuration

To use this MCP server in your project, add the following configuration:

{
    "mcpServers": {
        "location-service": {
            "command": "npx",
            "args": [
              "-y",
              "mylocation-mcp-server"
            ],
            "env": {
              "IPINFO_TOKEN": <IPINFO_TOKEN>
            }
        }
    }
}

Response Format

All tool responses follow the following JSON structure:

{
  "code": number,
  "data": object | null,
  "message": string
}

• code: Response status code (integer)
• data: Data object or null
• message: Response message (string)

Dependencies

📄 License

MIT License

With this project, you can easily integrate geolocation services into your application and leverage its powerful features for location-related operations.