项目简介

'mcp-korean-spell' 是一个基于 Model Context Protocol (MCP) 构建的服务器,专门为 LLM 应用提供韩语拼写检查功能。它通过注册 'fix_korean_spell' 工具,允许 LLM 客户端调用该工具来校对韩语文本中的拼写、语法和띄어쓰기错误。

主要功能点

  • 提供 'fix_korean_spell' 工具: LLM 可以调用此工具,传入韩语文本,服务器将返回校对后的文本。
  • 基于 MCP 协议: 采用标准化的 MCP 协议进行通信,易于与各种 MCP 客户端集成。
  • 使用 Naver 拼写检查 API: 底层使用 Naver 提供的拼写检查服务,保证校对质量。
  • Stdio 传输协议: 使用标准的 Stdio (标准输入输出) 作为 MCP 服务器的传输协议,部署简单方便。

安装步骤

  1. 安装 Node.js 和 npm: 确保你的环境中已安装 Node.js 和 npm (Node.js 包管理器)。
  2. 全局安装 '@winterjung/mcp-korean-spell': 打开终端,运行以下命令进行全局安装:
    npm install -g @winterjung/mcp-korean-spell
    或者使用 'yarn':
    yarn global add @winterjung/mcp-korean-spell

服务器配置

MCP 客户端需要配置以下信息才能连接到 'mcp-korean-spell' 服务器。以下是 JSON 格式的配置信息,通常在 MCP 客户端的配置文件中指定:

{
  "mcpServers": {
    "korean-spell-checker": {  // 服务器名称,客户端用于标识和引用
      "command": "npx",       // 启动服务器的命令,这里使用 npx 运行
      "args": [              // 启动命令的参数
        "-y",                 // npx 参数,自动确认安装包
        "@winterjung/mcp-korean-spell" // 要运行的 npm 包名称,即本服务器
      ]
    }
  }
}
  • 'mcpServers': 定义 MCP 服务器配置的顶级对象。
  • 'korean-spell-checker': 自定义的服务器名称,客户端使用此名称来引用该服务器。
  • 'command': 启动服务器的命令,这里使用 'npx',它允许直接运行 npm 包的可执行文件。
  • 'args': 传递给 'command' 的参数数组。
    • '"-y"': 'npx' 的参数,表示自动同意安装可能需要的 npm 包,避免运行时交互。
    • '"@winterjung/mcp-korean-spell"': 指定要通过 'npx' 运行的 npm 包名称,即已全局安装的 '@winterjung/mcp-korean-spell' 包。

基本使用方法

  1. 启动 MCP 服务器: 在终端中,无需手动启动 'mcp-korean-spell' 服务器。当 MCP 客户端尝试连接名为 'korean-spell-checker' 的服务器时,客户端会根据上述配置自动通过 'npx' 命令启动服务器。

  2. 客户端调用 'fix_korean_spell' 工具: 在 MCP 客户端中,可以使用以下方式调用 'fix_korean_spell' 工具:

    {
      "jsonrpc": "2.0",
      "method": "tool/invoke",
      "params": {
        "tool_name": "fix_korean_spell",
        "arguments": {
          "text": "이 글은 맛춤뻡 검사를 위함 글임니다." // 需要进行拼写检查的韩语文本
        }
      },
      "id": "some-request-id"
    }

    服务器会返回 JSON-RPC 响应,其中 'result.content' 字段包含校对后的文本:

    {
      "jsonrpc": "2.0",
      "result": {
        "content": [
          {
            "type": "text",
            "text": "이 글은 맞춤법 검사를 위한 글입니다." // 校对后的韩语文本
          }
        ]
      },
      "id": "some-request-id"
    }

注意事项

  • 该服务器依赖 Naver 拼写检查 API,如果 Naver API 服务不稳定,可能会影响服务器的正常运行。
  • 由于使用了 Naver API,可能存在请求频率限制。请合理使用,避免过高频率的请求。

信息

分类

AI与计算