PAELLADOC 使用说明

PAELLADOC 是一个 AI-First 开发框架，它通过实现 Anthropic 的 Model Context Protocol (MCP) 标准，使得大型语言模型 (LLM) 能够直接与您的项目上下文和 Paelladoc 提供的工具进行交互。它将文档和上下文视为核心资产，旨在改变传统的开发流程。

主要功能点

• 项目初始化与管理: 创建新的文档项目，加载或列出现有项目。
• 上下文集成: 允许 LLM 访问项目代码、结构、README、依赖等上下文信息。
• 文档生成与验证: 基于项目上下文和预定义模板，与 LLM 协作生成各类文档，并验证文档的完整性（基于 MECE 原则）。
• 工具调用: LLM 可以通过 MCP 调用 Paelladoc 暴露的功能工具，例如进行代码分析、管理产品特性或代码风格等（部分功能仍在开发中）。
• 持久化存储: 使用 SQLite 数据库存储项目记忆和文档元数据。
• 向量存储集成: 可选集成 ChromaDB 等向量数据库，用于更高级的上下文搜索和分析。

安装步骤

PAELLADOC 是一个 Python 应用。推荐在 独立的 Python 虚拟环境 中安装，以避免依赖冲突。

1. 创建并激活虚拟环境: 选择一个固定的目录，创建一个虚拟环境。

   python3.12 -m venv ~/.paelladoc_venv
   

   激活环境（命令取决于您的 shell，例如 Bash/Zsh 使用 'source ~/.paelladoc_venv/bin/activate'）。激活后，您的终端提示符前会显示 '(.paelladoc_venv)'。

2. 安装 PAELLADOC: 在 已激活 的虚拟环境中运行 pip 命令。

   pip install paelladoc
   

服务器配置 (MCP 客户端集成)

为了让您的 LLM 客户端（如 Cursor IDE）能够使用 PAELLADOC，您需要配置客户端连接到 PAELLADOC MCP 服务器。这通常涉及到编辑客户端的 MCP 配置文件（例如 Cursor 的 '.cursor/mcp.json'）。

您需要提供以下关键信息给客户端：

• 服务器名称: 一个唯一的名称来标识这个服务器（例如 "Paelladoc"）。
• 命令 (command): 启动 PAELLADOC 服务器的绝对路径。这通常是您在步骤 1 创建的虚拟环境中的 Python 可执行文件的绝对路径（例如 '/Users/您的用户名/.paelladoc_venv/bin/python'）。
• 参数 (args): 传递给 Python 命令的参数列表。标准参数包括指定要运行的模块 ('-m') 和 PAELLADOC MCP 服务器入口模块 ('paelladoc.ports.input.mcp_server_adapter')。您还需要指定传输协议，推荐使用标准输入输出 ('--stdio')。参数列表示例：'["-m", "paelladoc.ports.input.mcp_server_adapter", "--stdio"]'。
• 环境变量 (env): （可选但推荐）您可以在客户端配置中设置环境变量，特别是 'PAELLADOC_DB_PATH'，用于指定 Paelladoc 存储项目记忆数据库 'memory.db' 的位置。这比在 shell 启动文件中设置环境变量更可靠，确保 LLM 启动的进程能正确继承该路径。

请查阅您的 LLM 客户端文档，了解如何在 MCP 配置文件中以 JSON 格式正确填写上述信息。

基本使用方法

一旦 PAELLADOC MCP 服务器在您的 LLM 客户端中配置并成功启动，您就可以通过与 LLM 自然语言对话来使用 PAELLADOC 的功能。

通常，启动一个新项目或管理现有项目从 'PAELLA' 或 'CONTINUE' 命令开始。LLM 将会调用对应的 PAELLADOC 工具，并根据工具定义的交互流程引导您完成后续步骤（例如询问项目名称、语言、基础路径、选择分类等）。

示例对话：

• 用户: 我想开始一个新项目文档。
• LLM (调用 'paella_init' 或 'paella_list' 等): 好的，您想创建一个新项目还是继续现有项目？现有项目列表：[...]
• 用户: 创建一个新项目，叫做 "my-awesome-app"。
• LLM (调用 'paella_init'): 好的，"my-awesome-app" 项目，请指定项目的基本路径，以及文档语言和交互语言。

通过这种方式，LLM 作为前端界面，将您的自然语言请求转化为对 PAELLADOC MCP 服务器的工具调用，服务器则执行具体任务并返回结果或进一步的交互提示。