ProjectDoc
Enables AI editors to collaboratively manage project documentation, including todos, decisions, pitfalls, and interfaces, through MCP protocol tools.
README
ProjectDoc — 项目共建文档
AI 编辑器内的实时协作记录工具。通过 MCP 协议与 Claude Code、Codex、Cursor、Zed 等集成。
安装
pip install -e .
配置
在项目根目录添加 MCP 配置:
Claude Code (.mcp.json):
{
"mcpServers": {
"project-doc": {
"command": "project-doc",
"args": ["--project", "."]
}
}
}
Codex CLI (~/.codex/config.toml):
[mcp_servers.project-doc]
command = "project-doc"
args = ["--project", "."]
Cursor (.cursor/mcp.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,随项目版本控制或搬家。
测试
pytest tests/ -v
Recommended Servers
playwright-mcp
A Model Context Protocol server that enables LLMs to interact with web pages through structured accessibility snapshots without requiring vision models or screenshots.
Magic Component Platform (MCP)
An AI-powered tool that generates modern UI components from natural language descriptions, integrating with popular IDEs to streamline UI development workflow.
Audiense Insights MCP Server
Enables interaction with Audiense Insights accounts via the Model Context Protocol, facilitating the extraction and analysis of marketing insights and audience data including demographics, behavior, and influencer engagement.
VeyraX MCP
Single MCP tool to connect all your favorite tools: Gmail, Calendar and 40 more.
graphlit-mcp-server
The Model Context Protocol (MCP) Server enables integration between MCP clients and the Graphlit service. Ingest anything from Slack to Gmail to podcast feeds, in addition to web crawling, into a Graphlit project - and then retrieve relevant contents from the MCP client.
Kagi MCP Server
An MCP server that integrates Kagi search capabilities with Claude AI, enabling Claude to perform real-time web searches when answering questions that require up-to-date information.
E2B
Using MCP to run code via e2b.
Neon Database
MCP server for interacting with Neon Management API and databases
Qdrant Server
This repository is an example of how to create a MCP server for Qdrant, a vector search engine.
Exa Search
A Model Context Protocol (MCP) server lets AI assistants like Claude use the Exa AI Search API for web searches. This setup allows AI models to get real-time web information in a safe and controlled way.