# ProjectDoc — 项目共建文档

AI 编辑器内的实时协作记录工具。通过 MCP 协议与 Claude Code、Codex、Cursor、Zed 等集成。

## 安装

```bash
pip install -e .
```

## 配置

在项目根目录添加 MCP 配置：

**Claude Code** (`.mcp.json`):
```json
{
  "mcpServers": {
    "project-doc": {
      "command": "project-doc",
      "args": ["--project", "."]
    }
  }
}
```

**Codex CLI** (`~/.codex/config.toml`):
```toml
[mcp_servers.project-doc]
command = "project-doc"
args = ["--project", "."]
```

**Cursor** (`.cursor/mcp.json`):
```json
{
  "mcpServers": {
    "project-doc": {
      "command": "project-doc",
      "args": ["--project", "."]
    }
  }
}
```

## 工具

| 工具 | 用途 |
|------|------|
| `project_doc_todos` | 列出待办，开始工作前调用 |
| `project_doc_search` | 全文搜索，查已有决策/踩坑 |
| `project_doc_get` | 获取单条全文 |
| `project_doc_create` | 创建新条目 |
| `project_doc_append` | 追加内容（增量更新） |
| `project_doc_update` | 修改字段（状态/标签等） |
| `project_doc_list_tags` | 列出所有标签 |

## 标签约定

| 标签 | 何时使用 |
|------|----------|
| `decision` | 设计二选一时记录理由 |
| `pitfall` | 修复非显而易见的 bug |
| `interface` | 定义跨模块接口 |
| `todo` | 待办事项 |
| `wip` | 进行中的模块文档 |

## 数据库

自动创建在 `<项目>/.project-doc/project-doc.db`，随项目版本控制或搬家。

## 测试

```bash
pytest tests/ -v
```