使用说明

项目简介

汉字音典服务端是一个基于Bun和Elysia构建的后端服务，旨在提供汉字字形、读音、方言等详细信息的查询接口。它主要服务于需要汉字和方言数据的应用，例如语言学习工具、文化研究平台等。数据来源于开源项目 MCPDict。

主要功能点

汉字查询： 支持查询汉字的基本信息，包括字形、异体字等。
方言注音： 提供多种方言的汉字读音数据查询，可以指定方言范围进行查询。
方言信息： 提供方言的地理位置、文化特征等相关信息查询。
RESTful API： 通过简洁的RESTful API提供数据接口，方便各种客户端调用。
Swagger API文档： 集成Swagger UI，提供可视化的API文档和在线测试功能。

安装步骤

环境准备： 确保本地已安装 Python 3 和 Bun (一个快速的 JavaScript 运行时环境，类似于 Node.js)。

克隆仓库： 将 'mcpdict-backend' 仓库克隆到本地。

git clone https://github.com/vearvip/mcpdict-backend.git
cd mcpdict-backend

构建数据库： 运行以下命令构建项目所需的 SQLite 数据库。此步骤需要 Python 环境。
```
bun run makedb
```
安装依赖： 使用 Bun 安装项目依赖。
```
bun install
```

服务器配置

MCP客户端需要配置 MCP服务器的启动命令及其参数才能连接。以下是开发和部署环境的服务器配置示例（JSON 格式）：

开发环境配置：

{
  "server name": "mcpdict-backend-dev",
  "command": "bun",
  "args": ["run", "dev"]
}

'server name': 服务器名称，例如 "mcpdict-backend-dev"。
'command': 启动服务器的命令，这里使用 'bun'。
'args': 启动命令的参数，'run dev' 表示以开发模式启动服务器。

部署环境配置（Docker）：
```
{
  "server name": "mcpdict-backend",
  "command": "bun",
  "args": ["run", "work"]
}
```
- 'server name': 服务器名称，例如 "mcpdict-backend"。
- 'command': 启动服务器的命令，'bun'。
- 'args': 启动命令的参数，'run work' 表示以 Docker 镜像方式启动服务器（前提是已使用 'bun run build' 构建 Docker 镜像）。

基本使用方法

启动服务器： 根据选择的配置（开发或部署），运行相应的启动命令。例如，开发环境下运行 'bun run dev'。
查看API文档： 服务器启动后，访问 http://localhost:3000/swagger 查看 Swagger UI 提供的 API 文档，了解可用的接口和参数。
使用API接口： 根据API文档，向服务器发送 HTTP 请求以查询汉字和方言数据。例如，可以使用 POST 请求到 '/char' 接口查询汉字信息，或使用 GET 请求到 '/dialect' 接口查询方言列表。请求和响应数据格式通常为 JSON。

示例API请求 (查询汉字信息):

请求 (POST /char):

{
  "charList": ["汉", "字"],
  "dialectList": ["北京", "广州"]
}

响应 (JSON): (响应内容会根据实际数据有所不同，这里仅为示例)

{
  "success": true,
  "data": [
    {
      "char": "汉",
      "charInfo": {
        "北京": "hàn",
        "广州": "hon3"
      }
    },
    {
      "char": "字",
      "charInfo": {
        "北京": "zì",
        "广州": "zi6"
      }
    }
  ],
  "variants": ["汉", "字"]
}

注意： 本项目提供的是基于 RESTful API 的数据服务，并非严格意义上实现了基于 JSON-RPC 的 Model Context Protocol (MCP) 服务器。它更侧重于提供结构化的汉字和方言数据，可以作为 LLM 应用的上下文信息来源之一。

关键词

使用说明

信息