本地 MCP。它读取一个项目目录,先给出上手地图,再给出会挡住新人的审查发现。叙述由 Cursor 里的模型来写,本服务只返回扫描到的事实。
SherryCheck 本身不访问网络。相似仓库由 Cursor 里已配置的 GitHub MCP 搜索,本服务只生成搜索词并对比根目录条目。疑似密钥只报告文件和行号,不返回原文。扫描会跳过 node_modules、.git、dist、venv 等依赖和构建目录,文件数上限为 4000,单文件读取上限为 256KB。
scan_project(path):语言、清单、安装/运行/测试/检查命令、入口、顶层目录职责、阅读顺序、单体仓或单包。review_project(path):按严重程度排列的发现。包括缺少 README、看不出怎么运行、入口过多、没有测试或持续集成、缺少锁文件、有.env但没有示例、疑似密钥、待办热点、没有格式化或检查配置。build_github_query(path):生成search_repositories的查询、排序、数量,以及要排除的owner/repo。配置关闭对比时enabled为 false。compare_with_peers(path, peers):根据对方仓库根目录条目,列出对方有而本地没有的项,以及本地有而对方没有的项。write_brief(path, overwrite=false, peers=null):按个人配置写成 Markdown。没有 peers 时,对比一节写“未对比”。- 提示词
onboard(path):先扫描再审查;对比开启时再调用 GitHub MCP 的search_repositories和get_file_contents,然后写简报。
个人配置放在 %USERPROFILE%\.sherrycheck\profile.toml,样例见 examples/profile.toml。项目根目录的 .sherrycheck.toml 只覆盖 focus、output 和 compare。GitHub MCP 未配置时,扫描、审查和简报仍然可用。
path 使用项目根目录。相对路径按启动服务时的工作目录解析,在 Cursor 里应传工作区的绝对路径。
在 MCP 配置里加入:
{
"mcpServers": {
"sherrycheck": {
"command": "uv",
"args": [
"--directory",
"yourpath/sherrycheckmcp",
"run",
"sherrycheck"
]
}
}
}若 Cursor 找不到 uv,把 command 换成 uv.exe 的绝对路径。
配置完成后,打开要上手的那个项目再跟模型说。在本仓库的终端里运行 uv run sherrycheck 只会停在 stdio,那不是调用方式。
推荐使用提示词 onboard。path 填目标项目根目录的绝对路径。相对路径按启动服务时的工作目录解析,在 Cursor 里不可靠。
也可以直接说:「用已配置的 sherrycheck 帮我上手当前项目。」模型应调用这个 MCP 的工具,参数 path 用当前工作区的绝对路径。
工具顺序与提示词 onboard 一致:
scan_projectreview_projectbuild_github_query。enabled为 false,或 GitHub MCP 不存在、未登录、搜索为空时,跳过第 4 到第 6 步,不要编造仓库。- GitHub MCP 的
search_repositories - 对保留的每个仓库调用
get_file_contents,只保留根目录条目名。 compare_with_peerswrite_brief。有对比结果才传peers。
模型根据工具返回说明:这是什么、怎么跑起来、先读哪些文件、第一周该碰哪里、哪些问题会挡住上手。疑似密钥只提文件和行号。命令以工具返回为准。
简报默认写到目标项目根目录的 简报.md。文件已存在时不覆盖,除非调用 write_brief 时 overwrite 为 true,或个人配置里改了输出路径。
需要 Python 3.11 以上,以及能在终端里运行的 uv。
uv sync --group dev
uv run pytest
uv run sherrychecksherrycheck 使用 stdio,等待 MCP 客户端接入,单独在终端里运行时看起来会停住。