不背单词 MCP
by Maoleio
README.md
# 不背单词 MCP
将不背单词的个人生词本接入 ChatGPT 的 MCP 服务,面向 **ChatGPT Sites 私有部署**。登录后,可以在对话中查看生词、移除指定单词、查看自定义词书,或把英文词表创建为新的自定义词书。
许可证:[MIT](LICENSE)
## 功能概览
- 微信扫码登录不背单词账号,并查询登录状态。
- 读取全部生词,或随机抽取指定数量的生词。
- 移除一个明确指定的单词,并重新读取生词本核验结果。
- 查看自定义词书及其准确 `code`。
- 将英文词表导入为自定义词书。
- 在删除词书前执行二次确认,并在删除后重新读取列表核验。
## 部署到 ChatGPT Sites
部署需要具备 Sites 创建、配置和发布能力的 ChatGPT 或 Codex。请让Agent先阅读本项目的 [AGENTS.md](AGENTS.md),并说明:
> 请阅读 AGENTS.md,将这个项目部署到我自己的 ChatGPT Sites,创建一个仅本人可访问的新站点。完成测试、发布和 MCP 插件接入。部署完成后,必须以 Sites 原生发布结果为准,并验证 `/mcp` 的 `server/discover` 和 `tools/list`。
## 连接和登录
发布后,使用 Sites 自动生成的 MCP 插件连接服务。在 ChatGPT 中发送“登录不背单词”获取官方微信二维登录码。扫码后继续查询登录状态,只有返回 `authenticated` 才表示登录成功。如无法展示二维码,可打开网页进行登录,网页和 MCP 共用同一份会话。
## MCP 工具
| 工具 | 示例 | 作用 |
| --- | --- | --- |
| `start_login` | `{}` | 获取二维码;已有有效会话或待扫码任务时会复用 |
| `get_login_status` | `{}` | 查询扫码状态;只有 `authenticated` 表示成功 |
| `logout` | `{}` | 退出官网会话并清除当前服务会话,不注销账号 |
| `get_words` | `{"count":10}` 或 `{}` | 随机抽取指定数量,或读取全部生词 |
| `remove_word` | `{"word":"example"}` | 移除一个明确指定的单词并核验 |
| `list_books` | `{}` | 查看自定义词书、名称和准确 `code` |
| `import_words` | `{"words":"...","exam":"考研"}` | 创建自定义词书 |
| `delete_book` | `{"book_code":"词书code"}` | 经过确认后删除整本词书 |
### 导入限制
`import_words` 的 `words` 和 `exam` 必填。词表支持空格、逗号或换行分隔;自动去重和官网识别后,需要有 20–5000 个有效单词。`exam` 必须由用户明确选择以下之一:中考、高考、四级、六级、考研、专升本、雅思、其他。
`name` 和 `description` 可选。可以先使用 `dry_run: true` 预览识别结果;未识别词默认会停止保存,只有用户明确同意时才能使用 `skip_unrecognized: true`。官网接受创建请求后,词书可能还需要约 30 分钟处理完成,因此 `submitted` 不代表已经可以立即学习。
### 删除限制
`delete_book` 是不可恢复的危险操作。必须先用 `list_books` 获取准确的 `book_code`,不能仅凭名称猜测,也不能批量删除。
第一次调用只返回词书名称、`code`、风险和一次性确认凭据,不执行删除。只有用户明确确认同一词书后,才能携带 `confirmation_token` 再次调用。服务会重新读取词书列表,只有同时返回 `deleted: true` 和 `verified: true` 才算删除成功;结果不确定时先查列表,不自动重试。
## 会话和数据安全
站点应始终保持仅本人可访问,认证由 ChatGPT Sites 处理。官网 Cookie、登录任务和操作记录使用 `BBDC_SESSION_KEY` 加密后存入 R2。密钥只能配置在 Sites secret 中,不要写入源码、README、日志或 Git 提交。更换密钥会使已有加密会话无法读取。
## 目录结构
| 路径 | 用途 |
| --- | --- |
| `lib/` | 官网接口、词汇操作、词书管理、导入逻辑和工具定义 |
| `worker/cloud.js` | Sites 请求处理与加密会话存储 |
| `worker/index.js` | 构建生成的独立 Worker ESM |
| `web/index.html` | 服务介绍与网页登录页面 |
| `scripts/` | 构建、检查和 Sites 配置脚本 |
| `templates/hosting.json` | 无身份信息的 Sites 配置模板 |
| `test/` | 使用模拟响应的自动化测试 |
| `AGENTS.md` | 部署助手的 Sites 工作流和安全约束 |
## 本项目仅供学习使用,与不背单词官方无关。This server cannot be deployed
Maintenance
ActivityMaintained
ResponsivenessNo recent community issues