MCP Server TypeScript Starter

MCP 服务 TypeScript 入门模板

这是一个提供位置服务的 Model Context Protocol（MCP）服务实现。它演示了如何使用 TypeScript 构建 MCP 服务，并通过坐标或 IP 地址查询位置，提供实际功能。

功能

• TypeScript 配置
• 完整的 MCP 服务设置
• 位置服务实现
  • 基于坐标的位置查询
  • 基于 IP 的位置查询（使用 IPInfo.io）
  • 健康检查端点
• 类型安全的开发环境
• 与外部 API 集成

安装

npm install mylocation-mcp

用法

1. 创建一个 .env 文件，并填入 IPInfo.io API 令牌：

IPINFO_TOKEN=your_ipinfo_token_here

2. 在代码中导入并使用：

import { McpServer } from 'mylocation-mcp';

开发

如果你想修改此软件包或为其做出贡献：

# 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

项目结构

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

已实现的工具

1. get-location-by-coordinates

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

2. get-location-by-ip

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

3. health

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

MCP 服务配置

要在项目中使用此 MCP 服务，请添加以下配置：

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

响应格式

所有工具均按以下格式返回响应：

{
  "content": [
    {
      "type": "text",
      "text": "JSON string containing the response data"
    }
  ]
}

响应数据遵循以下结构：

{
  "status": "success|error",
  "source": "user_provided|ip_based",
  "data": {
    // Location data when successful
  },
  "error": "Error message when failed"
}

依赖项

• @modelcontextprotocol/sdk：MCP 服务实现
• zod：架构验证
• axios：用于 IPInfo API 的 HTTP 客户端
• dotenv：环境变量管理
• TypeScript 开发工具

许可证

MIT