McReadme-Card README

项目的 README,来自 github.com/colorfulee/McReadme-Card。合并为一个 markdown 文件:README.md。

麦门名片 · McReadme Card

把你的麦门履历,挂上 GitHub 主页。

一张每天自动刷新的 SVG 卡片:麦门职级、主力依赖、技术栈、贡献图、积分到期提醒、今日活动。
数据实时来自 麦当劳 MCP,全程只读。

热敏小票主题

receipt · 热敏小票主题


三套主题

neofetch 主题
neofetch · 终端风,给喜欢 rice 桌面的你
native 主题
native · GitHub 原生风,跟随系统深浅色,和 github-readme-stats 并排毫不违和

以上示例使用内置的虚构演示数据生成(npm run demo)。

30 秒挂上你的主页

1. 申请麦当劳 MCP Token

登录 open.mcd.cn/mcp,进入控制台激活并复制 Token。

2. 把 Token 存进主页仓库的 Secrets

打开你的主页仓库(与你的用户名同名,例如 octocat/octocat): Settings → Secrets and variables → Actions → New repository secret。名称填 MCD_MCP_TOKEN,值粘贴 Token。

3. 添加工作流

把 docs/profile-workflow.yml 复制到主页仓库的 .github/workflows/mcd-card.yml:

on:
  schedule:
    - cron: '17 1 * * *' # 每天北京时间 09:17 刷新
  workflow_dispatch:
permissions:
  contents: write
jobs:
  card:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: colorfulee/McReadme-Card@main
        with:
          mcd_token: ${{ secrets.MCD_MCP_TOKEN }}
          theme: receipt # 可选 receipt / neofetch / native,逗号分隔可生成多张

到 Actions 页面手动运行一次。

4. 在主页 README 里引用

![麦门名片](./mcd-card.svg)

完成。以后每天早上,你的麦门名片会自动刷新。

卡片里有什么

模块 含义 数据来源
麦门职级 L1–L6 🌱→🥉→🥈→🥇→🏆→👑 六级阶梯,从「麦门实习生」到「麦门架构师」 order-list
主力依赖 你最常点的那一款 order-list
技术栈 套餐拆分后的品类占比,像 GitHub 语言条一样 order-list
发版时段 早八发版 / 午间发版 / 下午茶 Hotfix / 晚间构建 / 夜间值守 order-list
贡献图 近 16 周哪些天"开过饭" order-list + 历史累积
可用积分 / 本月到期 积分快过期时用红字提醒 query-my-account
可用优惠券 卡包里还有几张券 query-my-coupons
NOW SERVING 今天正在进行的活动,每天轮换 campaign-calendar
条形码 扫一扫,是你的 GitHub ID(Code 39 彩蛋) —

麦门职级阶梯

奖牌逐级升格,每升一级多点亮一个品类图标,配一个专属主题色。卡片上会显示完整的六级阶梯:已达成的是彩色,当前等级高亮,未达成的是灰色。

职级 称号 徽章 已解锁图标 XP
L1 麦门实习生 · 新芽入麦 🌱 🍟 0
L2 初级麦门工程师 · 铜牌食客 🥉 🍟🍔 20
L3 麦门工程师 · 银牌常客 🥈 🍟🍔🥤 40
L4 高级麦门工程师 · 金牌老饕 🥇 🍟🍔🥤🍦 70
L5 资深麦门专家 · 奖杯级玩家 🏆 🍟🍔🥤🍦☕ 100
L6 麦门架构师 · 加冕麦门 👑 🍟🍔🥤🍦☕🥐 140

XP = 尝过的单品数 × 3 + 品类数 × 4 + 麦龄(月,最多 24)× 2。

设计原则:奖励探索,而不是多吃

配置项

输入 默认 说明
mcd_token 必填 麦当劳 MCP Token,务必放在 Secrets 里
theme receipt receipt / neofetch / native,逗号分隔生成多张
output mcd-card.svg 输出路径;多主题时为 mcd-card-<theme>.svg
github_user 仓库 Owner 卡片上显示的 ID
history .mcd-card/history.json 订单历史累积文件,填 off 关闭
hide 空 隐藏模块:points,coupons,campaign,graph,stack,channel,maindep
privacy normal strict 隐藏积分与优惠券数字
commit true 是否自动提交

为什么要累积历史?

order-list 每次只返回最近十来单。卡片每天运行时,会把新订单的统计字段追加到 .mcd-card/history.json,所以挂得越久,贡献图和技术栈越准。

本地预览 / 命令行

需要 Node.js ≥ 18,零依赖。

git clone https://github.com/colorfulee/McReadme-Card && cd McReadme-Card
npm run demo

使用演示数据,生成三张示例卡片到 examples/。

MCD_MCP_TOKEN=你的Token node src/cli.js --user 你的GitHubID --theme receipt,neofetch,native

使用真实数据生成卡片。完整参数见 node src/cli.js --help。

作为 Skill 使用(WorkBuddy / Claude 等 Agent)

skills/mcd-readme-card/SKILL.md 提供了 Agent Skill 的使用方式:在已连接麦当劳 MCP 的 Agent 里说一句「生成我的麦门名片」,Agent 会先调用只读工具采集数据,再在本地渲染出卡片。MCP 连接配置见 mcp-config.example.json。

隐私与安全

目标用户

项目结构

action.yml              GitHub Action(composite)
src/mcp-client.js       零依赖 MCP 客户端(Streamable HTTP,只读白名单)
src/unwrap.js           解析 MCP 返回(JSON / Markdown 包装)
src/normalize.js        订单、积分、券、活动日历归一化
src/history.js          订单历史累积(哈希去重、字段最小化)
src/stats.js            职级、技术栈、贡献图等指标
src/themes/             receipt / neofetch / native 三套主题
skills/mcd-readme-card/ Agent Skill 说明
test/                   node:test 单元测试

声明

本项目为「麦当劳程序员创意开发大赛」参赛作品,由参赛者独立开发,非麦当劳官方产品,不使用任何麦当劳官方标识。卡片内容仅供娱乐参考;餐品、价格、活动及供应状态以麦当劳官方渠道的实时信息为准。详见 CONTEST_DECLARATION.md。

如果它让你的主页可爱了一点,欢迎点个 ⭐。

McReadme-Card (colorfulee/McReadme-Card)

正在搜索数据库…

这是什么?McReadme Card 会为你的 GitHub 个人资料 README 生成一张每天自动更新的 SVG 卡片。卡片上展示一个有趣的“McDonald's 等级”,它基于你真实的点单记录生成,并包含技术栈占比、贡献图、积分过期提醒以及当天有效的促销活动。所有数据都通过 McDonald's MCP 服务以只读模式实时获取。
这是 GitHub Action、函数库还是应用程序?它是一个需要复制到你个人资料仓库中的 GitHub Actions 工作流,搭配一个零依赖的 Node.js 命令行工具(src/cli.js)来渲染 SVG。它也可以在本地运行,或通过 Agent Skill 调用。
如何让卡片在我的个人资料中运行起来?前往 open.mcd.cn/mcp 获取 McDonald's MCP 令牌,将其保存为你个人资料仓库中名为 MCDMCPTOKEN 的仓库密钥;把 docs/profile-workflow.yml 复制为 .github/workflows/mcd-card.yml;在 Actions 中手动运行一次;然后在 README 中引用生成的 SVG 文件。
使用这个工具必须有真实的 McDonald's 账户吗?是的,你必须注册 McDonald's MCP 服务并在 open.mcd.cn/mcp 生成令牌;卡片正是通过该令牌读取你的真实点单记录。
它会不会意外下单或兑换我的积分?不会。MCP 客户端只允许调用只读工具,因此下单、优惠券兑换、抽奖报名和积分兑换都在代码中被严格禁止,并有测试覆盖。
麦当劳等级(L1–L6)究竟是如何计算的?它基于经验值(XP)分数:尝试过的餐品数 ×3,尝试过的菜单分类数 ×4,再加上会员月数(上限为 24)×2。因此它奖励的是尝试新的菜单餐品,而非下单次数更多。
可以选择哪些视觉主题?内置三种 SVG 主题:“receipt”(热敏小票风格,默认)、“neofetch”(终端美化风格)、“native”(贴合 GitHub 原生风格,会随浅色/深色模式切换,并且与 github-readme-stats 搭配效果很好)。
能否由 AI 代理生成卡片,而不用 GitHub Actions?可以。skills/mcd-readme-card/SKILL.md 将其打包为一个 Agent Skill;只需告诉已连接的代理(如 Claude 或 WorkBuddy)为你生成卡片,它就会调用只读的 MCP 工具并在本地渲染。
这是麦当劳官方的产品吗?不是。这是为“麦当劳程序员创意开发大赛”提交的独立作品,与麦当劳没有任何隶属关系;所展示的菜单数据和活动信息仅供娱乐参考。
大小
0.1 MB
星标
135
更新
提交Oct 10
时长
1个月
提交 · 90 天