使用说明

项目简介

本项目实现了一个基于 Model Context Protocol (MCP) 的服务器,旨在为英语词汇学习应用提供后端支持。它允许大型语言模型(LLM)通过标准化的 MCP 接口,访问和操作词汇数据,以及调用学习辅助工具,从而增强AI驱动的词汇学习体验。

主要功能点

  • 单词管理:支持英语单词的增、删、改、查,包括单词的词形、发音、中英文翻译、例句、笔记等详细信息。
  • 学习进度跟踪:记录用户的单词学习会话,跟踪学习时间、记忆效果,并使用间隔重复算法智能安排复习计划。
  • 学习统计:提供单词的学习统计数据,如学习次数、总学习时间、平均记忆得分等,帮助用户了解学习情况。
  • 实用工具:内置文本翻译和例句生成工具(为占位实现,实际应用需替换为LLM驱动的实现),辅助单词学习过程。
  • 动态资源访问:通过资源 URL 动态获取指定单词的信息,方便LLM按需访问数据。

安装步骤

  1. 克隆仓库:将 GitHub 仓库 'https://github.com/IrvingYoung/LearnEnglishWordWithAI' 克隆到本地。
  2. 进入 'server' 目录:在终端中导航到克隆仓库的 'server' 目录下。
  3. 运行服务器:执行命令 'python mcp_server.py' 启动 MCP 服务器。

服务器配置

MCP 服务器需要 MCP 客户端通过配置信息才能连接。以下是本仓库 MCP 服务器的客户端配置信息(JSON 格式):

{
  "serverName": "EnglishWordLearning",
  "command": "python",
  "args": ["server/mcp_server.py"]
}
  • 'serverName': 服务器名称,必须与 'server/mcp_server.py' 中 'FastMCP("EnglishWordLearning")' 的名称一致。
  • 'command': 启动服务器的命令,这里使用 'python' 解释器。
  • 'args': 命令参数,指向服务器脚本 'server/mcp_server.py' 的路径。

请将以上配置信息填入您的 MCP 客户端配置中,以便客户端能够正确连接到本 MCP 服务器。

基本使用方法

  1. 启动服务器:按照安装步骤启动 MCP 服务器。
  2. 配置 MCP 客户端:使用上述服务器配置信息配置您的 MCP 客户端,建立与服务器的连接。
  3. 通过 MCP 客户端与服务器交互
    • LLM 或其他 MCP 客户端可以通过 JSON-RPC 协议调用服务器提供的工具(Tools)和访问资源(Resources),例如:
      • 调用 'saveWord' 工具保存新单词。
      • 调用 'getWord' 工具获取单词信息。
      • 调用 'trackWordStudy' 工具记录学习进度。
      • 访问 'word://{word_id}' 资源获取特定单词的详细信息。
    • 具体的工具和资源定义及其参数,请参考仓库 'README.md' 文件中 "MCP Server Interface" 部分的详细描述。

通过以上步骤,您可以成功部署和使用 LearnEnglishWordWithAI MCP 服务器,为您的 AI 词汇学习应用提供强大的后端支持。

信息

分类

AI与计算