项目简介
本仓库实现了一个基于 Model Context Protocol (MCP) 的服务器,旨在为大型语言模型 (LLM) 应用提供韩国本地化的地理位置服务。它集成了 Kakao 地图 API,提供了地址查询、地理编码、地点搜索和路径规划等功能。通过 MCP 协议,该服务器可以与兼容的 LLM 客户端进行交互,为 LLM 提供地理位置相关的上下文信息和工具能力,从而增强 LLM 在韩国本地场景下的应用。
主要功能点
- 地理编码 (Geocoding): 将韩文地址或地点名称转换为经纬度坐标。
- 地址搜索 (Address Search): 根据地点名称查找对应的详细地址信息。
- 路径规划 (Direction Search): 提供出发地到目的地的最佳路径,支持坐标和地址输入,并可获取详细的路径信息。
安装步骤
- 注册 Kakao Developers 账号并创建应用:
- 访问 kakao developers 并登录。
- 创建一个新的应用程序。
- 启用 Kakao Map API:
- 在应用控制台中,选择 "카카오 맵" (Kakao Map)。
- 启用 "활성화 설정" (Activation Settings)。
- 获取 REST API Key:
- 在应用控制台中,选择 "앱 키" (App Keys)。
- 复制 "REST API 키" (REST API Key),后续配置服务器时需要使用。
- 配置环境变量:
- 创建 '.env' 文件 (如果不存在),并将复制的 REST API Key 配置为环境变量 'KAKAO_REST_API_KEY'。例如:
KAKAO_REST_API_KEY=YOUR_KAKAO_REST_API_KEY
- 创建 '.env' 文件 (如果不存在),并将复制的 REST API Key 配置为环境变量 'KAKAO_REST_API_KEY'。例如:
- 安装依赖并启动服务器:
- 确保已安装 Node.js 和 npm。
- 克隆或下载本仓库代码。
- 在项目根目录下,打开终端并运行以下命令安装依赖:
npm install - 安装完成后,运行以下命令启动 MCP 服务器:
或者直接使用 'node src/index.ts' 启动。npm start
服务器配置
MCP 客户端需要配置以下信息才能连接到此 MCP 服务器。配置信息为 JSON 格式:
{ "serverName": "Demo", // 服务器名称,对应代码中 McpServer 实例化的 name 属性 "command": "node", // 启动服务器的命令,这里使用 node "args": ["src/index.ts"] // 启动命令的参数,指向服务器入口文件 }
参数说明:
- 'serverName': MCP 服务器的名称,用于客户端识别和连接。
- 'command': 运行 MCP 服务器的命令。通常为 'node' 或 Node.js 可执行文件的路径。
- 'args': 传递给 'command' 的参数列表,用于指定服务器启动脚本的路径。
注意: 确保 MCP 客户端能够访问到 Node.js 环境以及 'src/index.ts' 文件路径相对于客户端环境是正确的。 如果使用 'npm start' 启动,'command' 可以配置为 'npm','args' 配置为 '["start"]'。
基本使用方法
-
启动 MCP 服务器: 按照安装步骤启动服务器。
-
配置 MCP 客户端: 在 MCP 客户端中,配置上述服务器配置信息,建立与 MCP 服务器的连接。
-
调用工具 (Tools): 通过 MCP 客户端,可以调用服务器提供的以下工具:
- 'geocode': 根据地址或地点名称查询经纬度坐标。
- 'direction_search_by_coordinates': 根据经纬度坐标查询路径。
- 'direction_search_by_address': 根据地址名称查询路径。
- 'address_search_by_place_name': 根据地点名称查询地址信息。
客户端可以使用 JSON-RPC 协议向服务器发送请求,调用这些工具,并接收 JSON-RPC 响应,获取地理位置信息和路径规划结果。 具体请求和响应格式请参考 Model Context Protocol (MCP) 的官方文档。
信息
分类
网页与API