使用说明
mcp-claude工具
一个用于构建和记录的pnpm单仓库 @repo/sdk,一个TypeScript SDK,您可以将其用作库或通过 模型上下文协议 (MCP)。
它的作用
-
@repo/sdk TypeScript包提供:
printWorkingDirectory(directory)–返回给定路径的当前工作目录(在代理需要解析路径时非常有用)。reviewDiffsBeforeCommit(cwd?)–跑步git diff HEAD在给定目录中,将diff发送到Claude Code CLI进行审核,并返回审核文本。可选的.claude/skills/review-code/SKILL.md在存在时使用。
-
MCP服务器 –相同的SDK通过stdio作为MCP服务器公开,因此Cursor、Claude Desktop或其他MCP主机等工具可以将这些函数作为工具调用(例如“提交前查看我的差异”、“打印工作目录”)。
-
文档 –VitePress网站
apps/docs它记录了SDK,并通过TypeDoc保持同步。
回购结构
| 路径 | 描述 |
|---|---|
packages/sdk |
@repo/sdk–主库+MCP服务器入口点 |
packages/tsconfig |
共享TypeScript配置 |
packages/eslint-config |
共享ESLint配置 |
apps/docs |
VitePress文档网站 |
构建和编排: pnpm 工作空间+ 涡轮.
需求
- Node.js ≥ 18
- pnpm (参见
packageManager根package.json) - 对于
reviewDiffsBeforeCommit: Claude 代码命令行界面 已安装并打开PATH
命令(来自repo根目录)
pnpm install # Install dependencies
pnpm run build # Build all packages (no docs)
pnpm run build:all # Generate docs + build all
pnpm run dev # Run dev tasks (e.g. docs dev server)
pnpm run lint # Lint all packages
pnpm run format # Format with Prettier
pnpm run format:check # Check formatting
使用SDK
作为一个图书馆:
pnpm add @repo/sdk
import { printWorkingDirectory, reviewDiffsBeforeCommit, SDK_VERSION } from "@repo/sdk";
console.log(printWorkingDirectory("/some/path"));
console.log(reviewDiffsBeforeCommit()); // uses process.cwd()
作为MCP服务器:
该包裹附带了一个二进制文件 repo-sdk-mcp.将MCP客户端指向它(stdio传输)。光标配置示例:
{
"mcpServers": {
"@repo/sdk": {
"command": "npx",
"args": ["-y", "@repo/sdk", "mcp"]
}
}
}
或者直接运行内置服务器: node node_modules/@repo/sdk/dist/mcp-server.js (之后 pnpm install 在一个依赖于 @repo/sdk).
文档
从repo根目录:
pnpm run docs:generate # Generate API docs into apps/docs
pnpm --filter docs dev # Serve docs (if the docs app has a "dev" script)
docs应用程序位于 apps/docs 并且消耗所生成的API引用。