PAELLADOC is an AI-First development framework that implements the Model Context Protocol (MCP), allowing large language models to interact with development tools and context in a structured way. It transforms traditional development by making context the primary artifact instead of treating documentation as an afterthought.
PAELLADOC requires Python 3.12 or later and should be installed in a dedicated Python virtual environment.
# Navigate to where you want to store the environment
python3.12 -m venv .paelladoc_venv
# Activate the environment (bash/zsh)
source .paelladoc_venv/bin/activate
# For Fish shell
# source .paelladoc_venv/bin/activate.fish
# For Windows PowerShell
# .\.paelladoc_venv\Scripts\activate.ps1
# Make sure your virtual environment is activated
pip install paelladoc
You have two options for configuring where PAELLADOC stores its memory database:
Option 1: Environment Variable
export PAELLADOC_DB_PATH="$HOME/.paelladoc/memory.db"
Option 2: MCP Configuration (Recommended) Configure the database path directly in your LLM tool's MCP configuration file.
For Cursor IDE, edit the .cursor/mcp.json file to add PAELLADOC as an MCP server:
{
"mcpServers": {
"Paelladoc": {
"command": "/absolute/path/to/.paelladoc_venv/bin/python",
"args": [
"-m",
"paelladoc.ports.input.mcp_server_adapter",
"--stdio"
],
"cwd": "/path/to/your/project/directory",
"env": {
"PAELLADOC_DB_PATH": "/path/to/your/project/directory/paelladoc_memory.db",
"PYTHONPATH": "/path/to/your/project/directory/src:/path/to/your/project/directory"
},
"disabled": false
}
},
"mcp.timeout": 120000
}
If you're using Claude Desktop, you can install PAELLADOC automatically using Smithery:
npx -y @smithery/cli install @jlcases/paelladoc --client claude
Once installed and configured, interact with PAELLADOC through your LLM by using the following commands:
To start using PAELLADOC, simply type:
PAELLA
This will either list your existing projects or guide you through creating a new one.
PAELLADOC supports these primary commands:
PAELLA: Start new documentation projectsCONTINUE: Continue working on existing documentationVERIFY: Check documentation coverage and qualityGENERATE: Generate documentation or codeTo create a new project:
PAELLA
Then follow the LLM's prompts to set up your project.
To list existing projects:
PAELLA list
To continue working on an existing project:
CONTINUE project_name
The current stable version is 0.3.7, which is available on PyPI. This version includes the core functionality for project creation and management. For the latest development features, you can access the GitHub repository.
To add this MCP server to Claude Code, run this command in your terminal:
claude mcp add-json "Paelladoc" '{"command":"/absolute/path/to/.paelladoc_venv/bin/python","args":["-m","paelladoc.ports.input.mcp_server_adapter","--stdio"],"cwd":"/path/to/your/project/directory","env":{"PAELLADOC_DB_PATH":"/path/to/your/project/directory/paelladoc_memory.db","PYTHONPATH":"/path/to/your/project/directory/src:/path/to/your/project/directory"},"disabled":false}'See the official Claude Code MCP documentation for more details.
There are two ways to add an MCP server to Cursor. The most common way is to add the server globally in the ~/.cursor/mcp.json file so that it is available in all of your projects.
If you only need the server in a single project, you can add it to the project instead by creating or adding it to the .cursor/mcp.json file.
To add a global MCP server go to Cursor Settings > Tools & Integrations and click "New MCP Server".
When you click that button the ~/.cursor/mcp.json file will be opened and you can add your server like this:
{
"mcpServers": {
"Paelladoc": {
"command": "/absolute/path/to/.paelladoc_venv/bin/python",
"args": [
"-m",
"paelladoc.ports.input.mcp_server_adapter",
"--stdio"
],
"cwd": "/path/to/your/project/directory",
"env": {
"PAELLADOC_DB_PATH": "/path/to/your/project/directory/paelladoc_memory.db",
"PYTHONPATH": "/path/to/your/project/directory/src:/path/to/your/project/directory"
},
"disabled": false
}
}
}To add an MCP server to a project you can create a new .cursor/mcp.json file or add it to the existing one. This will look exactly the same as the global MCP server example above.
Once the server is installed, you might need to head back to Settings > MCP and click the refresh button.
The Cursor agent will then be able to see the available tools the added MCP server has available and will call them when it needs to.
You can also explicitly ask the agent to use the tool by mentioning the tool name and describing what the function does.
To add this MCP server to Claude Desktop:
1. Find your configuration file:
~/Library/Application Support/Claude/claude_desktop_config.json%APPDATA%\Claude\claude_desktop_config.json~/.config/Claude/claude_desktop_config.json2. Add this to your configuration file:
{
"mcpServers": {
"Paelladoc": {
"command": "/absolute/path/to/.paelladoc_venv/bin/python",
"args": [
"-m",
"paelladoc.ports.input.mcp_server_adapter",
"--stdio"
],
"cwd": "/path/to/your/project/directory",
"env": {
"PAELLADOC_DB_PATH": "/path/to/your/project/directory/paelladoc_memory.db",
"PYTHONPATH": "/path/to/your/project/directory/src:/path/to/your/project/directory"
},
"disabled": false
}
}
}3. Restart Claude Desktop for the changes to take effect