Mylocation MCP

🚀 MCP 服務器 TypeScript 啟動項目

本項目是基於模型上下文協議（MCP）的位置服務服務器實現。它展示瞭如何運用 TypeScript 構建 MCP 服務器，還能通過座標或 IP 地址進行位置查詢，為開發者提供了便捷的位置服務解決方案。

🚀 快速開始

本項目可讓你輕鬆將地理位置服務集成到應用中，利用其強大功能進行位置相關操作。使用前，你需完成安裝和環境變量的配置。

✨ 主要特性

• TypeScript 配置：提供類型安全的開發環境，提升開發效率和代碼質量。
• 完整的 MCP 服務器設置：搭建起基於 MCP 的服務器基礎架構。
• 位置服務實現：
  • 基於座標的地理位置查找：可根據提供的經緯度座標獲取地理位置信息。
  • 基於 IP 的位置查找（使用 IPInfo.io）：藉助 IPInfo.io 服務，通過 IP 地址查詢位置。
  • 健康檢查端點：方便檢查服務的健康狀態。
• 類型安全的開發環境：減少因類型錯誤導致的問題。
• 外部 API 集成：集成了 IPInfo.io 等外部 API，拓展功能。

📦 安裝指南

在項目中安裝本庫，可使用以下命令：

npm install mylocation-mcp

💻 使用示例

基礎用法

1. 配置環境變量

創建一個 .env 文件，並添加您的 IPInfo.io API 令牌：

IPINFO_TOKEN=your_ipinfo_token_here

2. 在代碼中導入並使用

import { McpServer } from 'mylocation-mcp';

高級用法

如果你想修改或貢獻給該項目，可按以下步驟操作：

# 克隆倉庫
git clone https://github.com/yhwancha/mylocation-mcp.git
cd mylocation-mcp

# 安裝依賴
npm install

# 設置環境變量
cp .env.example .env
# 編輯.env並添加您的IPInfo.io API令牌

# 構建項目
npm run build

📚 詳細文檔

項目結構

.
├── src/
│   └── index.ts    # 主服務器實現文件，包含位置工具
├── build/           # 編譯後的JavaScript文件
├── package.json    # 項目依賴和腳本
├── tsconfig.json   # TypeScript配置
├── .env.example    # 環境變量模板
└── README.md      # 文檔

已實現的工具

1. 通過座標獲取位置

server.tool(
  "get-location-by-coordinates",
  "從提供的座標獲取地理位置信息",
  {
    latitude: z.string().describe("緯度座標（-90到90之間）"),
    longitude: z.string().describe("經度座標（-180到180之間）")
  },
  async ({ latitude, longitude }) => {
    // 實現細節...
  }
);

2. 通過 IP 獲取位置

server.tool(
  "get-location-by-ip",
  "從IP地址獲取地理位置信息",
  {
    ipAddress: z.string().describe("要查詢的IP地址")
  },
  async ({ ipAddress }) => {
    // 實現細節...
  }
);

3. 健康檢查

server.tool(
  "health",
  "檢查服務的健康狀態",
  {},
  async () => {
    // 實現細節...
  }
);

MCP 服務器配置

要在您的項目中使用此 MCP 服務器，請添加以下配置：

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

響應格式

所有工具返回的響應都遵循以下 JSON 結構：

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

• code：響應狀態碼（整數）
• data：數據對象或 null
• message：響應消息（字符串）

依賴

📄 許可證

MIT License