ARTICLE DETAIL

资讯详情

深耕网站建设与运营推广的一线实战洞察。

用 AtomGit 托管 Cursor 项目模板:Rules、mcp.json、.gitignore 一键可复用仓库

用 AtomGit 托管 Cursor 项目模板:Rules、mcp.json、.gitignore 一键可复用仓库 「把我的 Cursor 配置发给你一下」——往往变成微信传 zip、密钥混在mcp.json、Rules 是一份只有作者自己懂的长文。更好的形态是一个可公开克隆的模板仓别人 10 分钟内能跑通「Rules 生效 一个 MCP 示例」且仓库里搜不到真实密钥。本文给出 AtomGit或任意 Git 托管友好的最小可复现结构Rules 模块、mcp.json.example、.gitignore、README 路径、可选敏感词检查脚本以及验收清单。对齐AtomGit 秋季与工具实践可读、可克隆、可展示。也适合内部分叉私有仓放真实默认值公开仓只留去密钥骨架。摘要模板仓零密钥示例只用占位符真实配置留在本机未跟踪文件。三件套.cursor/rules/mcp.json.example 安全向.gitignore。README 写路径克隆 → 复制配置 → 填环境变量 → 验证成功判据。可选脚本提交前扫明显密钥形态降低「示例污染」。验收新成员不靠口头传统就能开工。结论可复用的不是「你的私人 mcp.json」而是「去密钥后的结构 说明」。开源友好的第一天是让克隆者不必私聊你要 zip。结论卡组件仓库里放什么本机另放什么Rules00-core.mdc等可公开规范个人偏好可本地覆盖勿提交密钥MCPmcp.json.examplemcp.json或 env 注入Git.gitignore挡.env/产物真实.env文档README 交接模板—脚本check-no-secrets.sh可选CI 密钥扫描更强背景与边界AtomGit 适合国内协作与活动展示模板内容本身不绑定某一托管商。MCP 服务器种类繁多本文用通用的 stdio 示例结构说明配置方式不编造某产品的未公开字段。具体 Cursor 读取mcp.json的路径以当前客户端文档为准常见在项目.cursor/或用户配置中。不做教你绕过安全扫描不提供真实第三方 Token不把「能跑通」写成「可无人值守改生产」。示例服务器名称与参数请替换为你实际选用的官方文档写法。原理为什么要「example ignore」公开仓最常见事故是作者为了「别人一拉就能用」把 API Key 写进mcp.json并提交。正确模型是仓库提供结构与占位符克隆者复制为例外文件或注入环境变量.gitignore与扫描脚本做最后一道保险。可以把模板仓理解成「开发沙箱的骨架」它交付默认值与路径不交付你的生产身份。步骤搭建模板仓步骤 1初始化目录mkdircursor-project-templatecdcursor-project-templategitinitmkdir-p.cursor/rules scripts docs若已有业务仓可新建 orphan 分支或独立仓专门放模板避免把历史密钥提交一并公开。步骤 2写入.gitignore最小安全# 环境与密钥 .env .env.* !.env.example **/secrets/** *.pem *.p12 *.key # Cursor 本地实密配置保留 example .cursor/mcp.json .cursor/mcp.local.json # 依赖与产物 node_modules/ dist/ build/ coverage/ .next/ __pycache__/ *.pyc # 系统垃圾 .DS_Store Thumbs.db.env.example只放变量名与假值mcp.json实文件默认忽略避免「复制后随手 add」。步骤 3模块化 Rules公开可复用!-- .cursor/rules/00-core.mdc -- --- description: 模板仓铁律 alwaysApply: true --- - 禁止提交密钥、Token、私钥 - 使用仓库文档指定的包管理器 - 改动后给出验证命令 - 回答使用中文 - 最小 diff不相关重构单独开任务!-- .cursor/rules/10-lang.mdc -- --- description: 语言与代码风格按需改 globs: - **/*.{ts,tsx,js,jsx,py} alwaysApply: false --- - 优先最小 diff避免无关重构 - 新增代码需说明如何运行相关测试!-- .cursor/rules/90-release.mdc -- --- description: 发版清单手动 alwaysApply: false --- - 版本号与变更说明是否同步 - 是否包含回滚要点公开模板的 Rules 要克制示范「怎么拆」而不是倾销作者公司的全部合规长文。下游可以加上游应能删。步骤 4mcp.json.example占位符{mcpServers:{example-filesystem:{command:npx,args:[-y,modelcontextprotocol/server-filesystem,/absolute/path/to/allowed],env:{EXAMPLE_TOKEN:${EXAMPLE_TOKEN}}}}}说明写进 README复制cp .cursor/mcp.json.example .cursor/mcp.json用环境变量注入不把真实 Token 写入文件若必须写入确保已被 gitignore文件系统类服务器务必限制在允许目录不要指向整盘或家目录以上为结构示例包名与参数以你实际选用的 MCP 服务器文档为准。若你的 Cursor 版本支持用户级与项目级配置分层在 README 写清「本模板使用哪一层」。步骤 5.env.example# 复制为 .env 后填写勿提交 .envEXAMPLE_TOKENreplace_me保持「变量名可见、值不可信」演示截图里也不要出现真 Token。步骤 6README 上手路径活动向建议 README 固定五段这是什么Cursor 项目模板Rules MCP 示例 ignore快速开始克隆 → 复制 mcp 示例 → 导出环境变量 → 用 Cursor 打开验证成功能在 MCP 面板看到示例服务器 / 能列出 tool按你实际服务器写安全声明本仓不含真实密钥发现疑似密钥请提 Issue目录说明一张树状列表对应本文结构图活动评审常见扣分点是「只有概念没有路径」。把命令写到可复制级别。步骤 7可选scripts/check-no-secrets.sh#!/usr/bin/env bashset-euopipefail# 极简启发式拒绝明显密钥形态按需扩展难免误报ifgitgrep-I-EAKIA[0-9A-Z]{16}|BEGIN RSA PRIVATE KEY|api[_-]?key[[:space:]]*[[:space:]]*[][A-Za-z0-9]{20,} -- . \ :(exclude)*.md :(exclude)*.example :(exclude)docs/**;thenechoPossible secret-like string found. Remove before commit.exit1fiechoOK: no obvious secret-like patterns in tracked non-doc files.chmodx scripts/check-no-secrets.sh ./scripts/check-no-secrets.sh可在本地 pre-commit 或 CI 调用。它不能替代正规密钥扫描产品只是模板仓的最小护栏。误报时用排除路径而不是直接删掉检查。步骤 8交接文档docs/AGENT_HANDOFF.md# Agent 阶段交接 ## 已完成 - ## 未完成 - ## 验证命令 bash # 例如pnpm test --filter web禁止事项不要改生产配置不要提交 .env不要扩大 MCP 文件系统根目录这让「可续跑」有纸面形态换会话、换人、换机器时不靠聊天记录考古。 ## 推到 AtomGit bash git add . git status # 确认没有 .env / mcp.json 实文件 git commit -m chore: init Cursor project template # 在 AtomGit 创建空仓后 git remote add origin your-atomgit-repo-url git push -u origin main推送前再跑一遍git grep与检查脚本。README 顶部可加活动向说明「适合 AtomGit 秋季结构清晰 / 零密钥 / 可验证」。场景三种复用方式用法做法新项目起点克隆后改名删无关示例填自己的 glob老项目接入只拷.cursor/rules与 ignore 片段勿覆盖已有机密配置培训/演示固定「验证成功」步骤现场只用假 Token内外双仓公开仓骨架 私有仓叠加公司 Rules注意许可证失败案例example 里留真 Token「我先写上过两天再删」——两天足够被爬。忽略规则过窄只 ignore.env却提交config/secret.json。Rules 太作者化个人文风进 Always下游直接卸掉。MCP 指向过宽目录filesystem 根目录设成家目录。README 只有幸福路径克隆者卡在面板看不到服务器只能私聊你。把业务代码和模板混仓历史提交里的旧密钥一起公开。验收清单新成员可按 README 独立完成启用仓内搜不到真实 Key/Token 形态00-core.mdc短且 Always存在mcp.json.example真实文件被 ignore写明验证成功判据可选敏感词脚本可运行git status干净无.env、无实密mcp.json演示截图已打码活动向README 最小「triple」AtomGit 秋季展示时建议同时具备文档本文所述 README 路径脚本至少一种可运行检查或启动说明截图/结构图目录树或验证面板注意打码。缺一仍可开源但评委与协作者的理解成本会明显上升。进阶从模板到「可分叉的团队默认」个人模板跑通后团队往往需要第二层公司内部私有模板。推荐双层结构而不是把私有条款硬塞进公开仓。层托管内容公开骨架AtomGit 公开仓core 短规则、example、ignore、README私有叠加内网 Git合规细则、内部 MCP、私有 Docs 索引接入方式示例业务仓先引入公开骨架subtree/拷贝均可再合并私有 Rules 目录注意命名空间如50-company-*.mdc私有mcp.json.example指向内网服务器仍用环境变量CI 在私有仓跑更强的密钥扫描。这样活动展示与对外 README 保持干净内部也不会因为「不敢开源」而失去模板红利。配置漂移如何保持模板不腐烂模板仓三个月后最常见的死法是Cursor 字段变了、MCP 示例包名变了、README 命令失效。建议每季度做一次「空白机器演练」新目录克隆 → 按 README 走 → 记录失败步骤用 Issue 标签template-breakage收集失效报告示例 MCP 宁可选保守、文档稳定的服务器也不要追每周新 Demo版本变更写进CHANGELOG.md三五行即可。「一键可复用」是承诺承诺需要维护成本维护成本应写进团队轮值而不是假设作者永生。最小演示脚本可选若希望评审者无需理解 MCP 细节也可提供「仅 Rules」模式# 只验证仓库结构不启动 MCPtest-f.cursor/rules/00-core.mdctest-f.cursor/mcp.json.exampletest-f.gitignoregrep-q.cursor/mcp.json.gitignoreechostructure OK把该脚本写进 README「60 秒结构检查」降低活动展示的环境依赖。许可与归属公开模板请显式选择许可证例如 MIT / Apache-2.0并在 README 声明示例代码与规则文本的许可第三方 MCP 服务器各自遵循其上游许可不提供担保模板不构成安全认证。避免下游公司法务因为「随便拷了一份无许可仓」而阻断内部推广。FAQ模板仓高频问题Q1为什么不直接提交可用的 mcp.json因为「可用」几乎总等于「带身份」。模板的价值是结构不是你的 Token。用 example 环境变量克隆者五分钟可填整仓却不会变成密钥喷泉。Q2Rules 要不要写成公司全量规范公开模板不要。全量规范放私有叠加层。公开仓示范「如何拆 Always / glob / 手动」示范「短 core」即可。下游加码容易上游减肥难。Q3AtomGit 与 GitHub 双远程怎么办可以。保持同一去密钥骨架推送前同一套检查脚本。注意两处可见性设置都要是你想要的别把私有叠加误推到公开远程。Q4检查脚本误报怎么办先缩正则或加排除路径不要直接删除检查。误报记录进 FAQ避免后来者重复踩坑。Q5模板里要不要放真实业务示例代码可放「假业务」最小应用例如 hello API便于验证 Agent 改文件闭环但不要从生产仓拷历史。示例代码同样禁止硬编码密钥。端到端演练脚本给人看的检查单把下面清单贴进 Issue作为「新人第一次使用」的打卡克隆仓库到新目录不要用你日常已污染的工作树。复制mcp.json.example→mcp.json或按 README 使用用户级配置。复制.env.example→.env并填入假值或测试值。用 Cursor 打开确认 Rules 面板/规则列表能看到00-core。若启用 MCP确认面板出现示例服务器调用一个只读 tool。运行scripts/check-no-secrets.sh若有应通过。故意在暂存区放入含API_KEY...的文件确认你不会把它提交gitignore 或检查脚本应拦住。删掉本地.env与实密配置确认工作树可干净回到「可公开状态」。演练通过才叫「一键可复用」只在作者机器上成功叫「我自己能用」。内容配图说明投稿时封面三件套Rules / mcp 示例 / gitignore文内仓库树、克隆四步、gitignore 清单、验收清单配图均在 images 目录正文用相对路径引用方便本地预览与日后上传。一句话带走模板仓交付的是「可复制的安全默认值」Rules 可裁剪、MCP 可示例、密钥永不进库。AtomGit 上展示时同事应能克隆即懂而不是向你私聊要 zip。先做到零密钥与可验证再谈炫技集成。草稿未发布 · 作者 梧桐秋海 · 活动九月创作之星、AtomGit秋季、工具实践
返回列表