使用说明
CodeWeaver MCP服务器
通过模型上下文协议将整个代码库转换为单个AI可读的Markdown文档。
英语| 简体中文
CodeWeaver MCP Server为Claude code等AI助手带来了强大的代码打包功能。它将复杂的项目结构转换为干净、可导航的Markdown文件,非常适合代码审查、文档、人工智能分析和与团队共享。
为什么选择CodeWeaver MCP?
🚀 无缝AI集成
- 本地MCP协议:与Claude Code和其他MCP兼容的AI助手开箱即用
- 零上下文切换:直接从AI工作流访问代码库打包
- 即时结果:立即获取Markdown输出或保存到文件
📦 完全代码库可见性
- 完整结构捕获:整个项目层次结构的美丽树状图
- 包含所有代码:每个文件的内容都嵌入了正确的语法高亮显示
- 智能过滤:尊重
.gitignore并支持自定义忽略模式
💡 非常适合多个用例
用于AI分析
- 将整个代码库提供给AI模型(ChatGPT、Claude等)
- 无需手动文件共享即可实现全面的代码理解
- 非常适合代码审查和重构讨论
用于文档
- 生成即时项目快照
- 创建可共享的代码库文档
- 归档关键里程碑的项目状态
团队协作
- 与队友分享完整的项目背景
- 更快地引入新开发人员
- 促进远程代码讨论
用于代码审查
- 具有完整上下文的包拉取请求
- 在一个文档中查看整个功能
- 跨多个文件跟踪代码更改
特性
🎯 纯TypeScript实现
- 无外部依赖关系:完全内置TypeScript-不需要Go、Python或其他运行时
- 快速轻便:高效的文件扫描和处理
- 交叉平台的:适用于macOS、Linux和Windows
🛠️ 强大的定制功能
- 灵活过滤:包含/排除具有glob模式的文件
- Gitignore支持:自动尊重您的
.gitignore规则 - 自定义图案:添加特定于项目的忽略模式
- 多种输出模式:直接返回内容或保存到文件
📝 智能Markdown输出
- 语法高亮显示:20多种编程语言的自动语言检测
- 干净的格式:使用方框绘制字符的专业树形结构
- 有组织的布局:逻辑文件顺序(目录优先,按字母顺序排列)
- 相对路径:清除文件位置引用
安装
先决条件
- Node.js 18或更高版本
- npm或纱线
快速安装
# Clone and build
git clone https://github.com/yourusername/codeweaver-mcp-server.git
cd codeweaver-mcp-server
npm install
npm run build
添加到克劳德代码
claude mcp add codeweaver node /absolute/path/to/codeweaver-mcp-server/dist/index.js
或手动添加到 ~/.claude/config.json:
{
"mcpServers": {
"codeweaver": {
"command": "node",
"args": ["/absolute/path/to/codeweaver-mcp-server/dist/index.js"]
}
}
}
用法
基本用法
打包当前目录:
codeweaver_pack_codebase({
path: "."
})
保存到文件
codeweaver_pack_codebase({
path: "./src",
output: "codebase.md"
})
包含Gitigned文件
codeweaver_pack_codebase({
path: ".",
include_gitignored: true
})
自定义忽略模式
codeweaver_pack_codebase({
path: ".",
ignore_patterns: ["*.log", "tmp/*", "*.tmp"]
})
输出格式
CodeWeaver生成干净、结构化的Markdown:
# project-name
## Directory Structure
├── src │ ├── index.ts │ └── utils.ts └── package.json
## Files
### src/index.ts
```typescript
// Full file content with syntax highlighting
import { helper } from './utils';
...
src/utils.ts
// Full file content
export function helper() { ... }
## Supported Languages
Automatic syntax highlighting for:
- TypeScript/JavaScript (`.ts`, `.tsx`, `.js`, `.jsx`)
- Python (`.py`)
- Go (`.go`)
- Rust (`.rs`)
- Java (`.java`)
- C/C++ (`.c`, `.cpp`, `.h`, `.hpp`)
- C# (`.cs`)
- Ruby (`.rb`)
- PHP (`.php`)
- Swift (`.swift`)
- Kotlin (`.kt`)
- SQL (`.sql`)
- Shell (`.sh`)
- YAML (`.yaml`, `.yml`)
- JSON (`.json`)
- XML (`.xml`)
- HTML (`.html`)
- CSS (`.css`)
- Markdown (`.md`)
## Default Ignore Patterns
CodeWeaver automatically skips:
- `node_modules/`
- `.git/`
- `dist/` and `build/`
- `.next/` and `.nuxt/`
- `vendor/`
- Python virtual environments (`venv/`, `.venv/`, `__pycache__/`)
- System files (`.DS_Store`, `Thumbs.db`)
## Real-World Examples
### Example 1: Share Code with ChatGPT
```typescript
// Pack your project
codeweaver_pack_codebase({
path: "./my-app",
output: "my-app-context.md"
})
// Copy the Markdown file content and paste into ChatGPT
// Now ChatGPT can see your entire codebase!
示例2:代码审查文档
// Pack only source code
codeweaver_pack_codebase({
path: "./src",
ignore_patterns: ["*.test.ts", "*.spec.ts"],
output: "review-package.md"
})
示例3:项目快照
// Capture complete project state
codeweaver_pack_codebase({
path: ".",
output: `snapshot-${new Date().toISOString()}.md`
})
api参考
codeweaver_pack_codebase
参数:
| 参数 | 类型 | 必填 | 默认 | 说明 |
|---|---|---|---|---|
path |
string | ✅ 是 | - | 要打包的目录路径 |
output |
string | ❌ 否 | - | 输出文件路径(如果省略,则返回内容) |
include_gitignored |
boolean | ❌ 没有 | false |
包括中列出的文件 .gitignore |
ignore_patterns |
string[] | ❌ 没有 | [] |
要忽略的其他glob模式 |
退货:
- 如果
output指定:带有文件路径和大小的成功消息 - 如果
output省略:完整的Markdown内容
错误处理:
"Error: Path does not exist"-目录路径无效"Error: Path is not a directory"-路径指向文件- 二进制文件会自动跳过并发出通知
发展
从源代码构建
npm install
npm run build
发展模式
npm run dev
清洁建筑
npm run clean
npm run build
为什么选择CodeWeaver MCP?
✅ AI优先工作流程:专为AI工具构建,与通用文件打包器不同 ✅ 零配置:立即处理合理的默认值 ✅ 专业输出:人类和人工智能喜爱的干净易读的Markdown ✅ 现代堆栈:纯TypeScript,无遗留依赖 ✅ 积极发展:定期更新新功能 ✅ MIT许可证:个人和商业用途免费
与备选方案的比较
| 特性 | CodeWeaver MCP | 命令行工具 | VSCode扩展 |
|---|---|---|---|
| 人工智能集成 | ✅ 本地MCP | ❌ 手动复制粘贴 | ⚠️ 有限 |
| 零配置 | ✅ 是 | ❌ 复杂标志 | ✅ 是的 |
| 跨平台 | ✅ 是 | ⚠️ 变化 | ⚠️ 仅VSCode |
| 实时使用 | ✅ 是 | ❌ 否 | ⚠️ 有限 |
| TypeScript原生 | ✅ 是 | ❌ 各种 | ⚠️ 变化多样 |
贡献
欢迎投稿!请随时提交问题或拉取请求。
许可证
MIT许可证-请参阅 许可证 详细信息文件
致谢
灵感来自原作 CodeWeaver 该项目已针对模型上下文协议生态系统进行了调整。
由...制作❤️ 面向人工智能开发社区
