# LocalProjectManager

**Repository Path**: wei_bin_9966/local-project-manager

## Basic Information

- **Project Name**: LocalProjectManager
- **Description**: 本地项目管理工具，用来快速浏览项目结构，可以支持快速搜索文件内容等
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-11-10
- **Last Updated**: 2025-11-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Local Project Manager MCP

本地项目管理 MCP 服务器 - 让 Claude 能够直接访问、管理和操作你本地的开发项目。

## 功能特性

- ✅ 列出所有配置的项目
- ✅ 扫描项目目录结构
- ✅ 读取项目文件内容
- ✅ 写入/修改项目文件
- ✅ 在项目中搜索文件名或内容
- ✅ 获取项目详细信息
- ✅ 添加新项目到管理
- ✅ 批量读取多个文件

## 安装

```bash
# 克隆项目
git clone <your-repo-url>
cd local-project-manager-mcp

# 安装依赖
npm install

# 编译
npm run build
```

## 配置

### 1. 创建配置文件

在用户目录下创建配置文件：`~/.local-project-mcp/config.json`

Windows: `C:\Users\<YourName>\.local-project-mcp\config.json`

```json
{
  "version": "1.0.0",
  "projects": {
    "my-project": {
      "id": "my-project",
      "name": "我的项目",
      "path": "D:\\Projects\\MyProject",
      "type": "generic",
      "description": "项目描述",
      "excludePatterns": ["node_modules", "dist", ".git"],
      "tags": ["active"]
    }
  },
  "settings": {
    "maxFileSize": "10MB",
    "encoding": "utf-8",
    "ignoreHiddenFiles": true
  }
}
```

### 2. 配置 Claude Desktop

编辑 Claude Desktop 配置文件：

**Windows**: `%APPDATA%\Claude\claude_desktop_config.json`
**macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`

```json
{
  "mcpServers": {
    "local-project-manager": {
      "command": "node",
      "args": [
        "E:\\其他代码\\LocalProjectManager\\dist\\index.js"
      ]
    }
  }
}
```

### 3. 重启 Claude Desktop

配置完成后，重启 Claude Desktop 即可使用。

## 可用工具

### 1. list_projects
列出所有配置的项目

```
参数：
- filter (可选): 按标签过滤，如 "active"
```

### 2. read_file
读取项目文件内容

```
参数：
- projectId: 项目ID
- filePath: 文件相对路径
- encoding (可选): 文件编码，默认 utf-8
```

### 3. write_file
写入或修改文件

```
参数：
- projectId: 项目ID
- filePath: 文件相对路径
- content: 文件内容
- createIfNotExists (可选): 是否创建新文件，默认 true
- backup (可选): 是否备份原文件，默认 true
```

### 4. scan_project_structure
扫描项目目录结构

```
参数：
- projectId: 项目ID
- depth (可选): 扫描深度，默认 3
- includeFiles (可选): 是否包含文件列表，默认 true
```

### 5. search_in_project
在项目中搜索

```
参数：
- projectId: 项目ID
- searchType: "filename" 或 "content"
- query: 搜索关键词
- filePattern (可选): 文件类型过滤，如 "*.java"
- maxResults (可选): 最大结果数，默认 50
```

### 6. get_project_info
获取项目详细信息

```
参数：
- projectId: 项目ID
- includeStats (可选): 是否包含统计信息，默认 true
```

### 7. add_project
添加新项目

```
参数：
- projectId: 项目唯一标识
- name: 项目名称
- path: 项目绝对路径
- type: 项目类型 (csharp-winform | spring-boot | vue3 | generic)
- description (可选): 项目描述
- tags (可选): 项目标签数组
- excludePatterns (可选): 排除模式数组
```

### 8. batch_read_files
批量读取文件

```
参数：
- projectId: 项目ID
- filePaths: 文件路径数组
- maxFiles (可选): 最多读取文件数，默认 20
```

## 使用示例

在 Claude Desktop 中：

```
你: "列出我所有的项目"
Claude: [调用 list_projects 工具]

你: "帮我看看 my-project 项目的 README.md 文件"
Claude: [调用 read_file 工具]

你: "在 my-project 中搜索所有包含 'TODO' 的文件"
Claude: [调用 search_in_project 工具，searchType: "content"]

你: "扫描 my-project 的目录结构"
Claude: [调用 scan_project_structure 工具]
```

## 项目类型

支持的项目类型：

- `csharp-winform`: C# WinForm 项目
- `spring-boot`: Spring Boot 后端项目
- `vue3`: Vue3 前端项目
- `generic`: 通用项目

每种类型都有预设的排除模式。

## 文档结构

项目文档已按以下结构组织在 `docs/` 目录中：

```
docs/
├── guides/           # 使用指南
│   ├── MCP_SETUP_GUIDE.md     # MCP 设置指南
│   └── QUICKSTART.md          # 快速入门指南
├── reference/        # 参考文档
│   ├── CLAUDE_DESKTOP_CONFIG.md      # Claude 桌面配置
│   ├── LocalProjectManagerMcp.md     # MCP 服务器参考
│   ├── OPTIMIZATION_SUMMARY.md       # 优化总结
│   ├── README_INDEX_OPTIMIZATION.md  # 索引优化
│   ├── SEARCH_INDEX_CONCEPT.md       # 搜索索引概念
│   └── TOKEN_OPTIMIZATION.md         # Token 优化
├── deployment/       # 部署文档
│   ├── DEPLOYMENT_CHECKLIST.md       # 部署检查清单
│   ├── FIX_DATABASE_STRUCTURE.md     # 数据库结构修复
│   └── RUN_TESTS.md                  # 测试运行指南
└── chinese/          # 中文文档
    ├── 使用注意事项.md       # 使用注意事项
    ├── 项目完成说明.md       # 项目完成说明
    └── 验收清单.md           # 验收清单
```

## 开发

```bash
# 开发模式（自动重启）
npm run dev

# 编译
npm run build

# 运行
npm start
```

## 许可证

MIT