⚠️ DEPRECATED: This Node.js package is deprecated. Please use the direct HTTP/SSE method instead (see below).

A Model Context Protocol (MCP) client that enables AI assistants like Cursor, Claude, and ChatGPT to interact with DocuWriter.ai for documentation generation and space management.

The simplest and recommended way to connect DocuWriter.ai is via direct URL - no NPM package needed!

Add this to your MCP configuration file:

Cursor (.cursor/mcp.json):

{
  "mcpServers": {
    "docuwriter": {
      "url": "https://app.docuwriter.ai/mcp",
      "headers": {}
    }
  }
}

Claude Desktop (~/Library/Application Support/Claude/claude_desktop_config.json):

{
  "mcpServers": {
    "docuwriter": {
      "url": "https://app.docuwriter.ai/mcp",
      "headers": {}
    }
  }
}

ChatGPT: Configure in ChatGPT Settings → MCP → New Connector

• Name: DocuWriter.ai
• URL: https://app.docuwriter.ai/mcp

• ✅ No installation required - Just add the URL
• ✅ No Node.js dependencies - Pure HTTP/SSE
• ✅ OAuth authentication - Secure, automatic token management
• ✅ Always up-to-date - No manual updates needed
• ✅ Works everywhere - Cursor, Claude Desktop, ChatGPT, and more

On first connection, you'll be prompted to authorize via OAuth. After that, authentication is handled automatically.

• User Management: Get user information and authentication status
• Space Management: List and search documentation spaces
• Document Search: Search within specific documentation spaces
• Code Generation: Generate documentation, tests, and optimizations for source code
• Multi-File Documentation: Generate comprehensive documentation for multiple source files with token validation
• Complete CRUD Operations: Create, read, update, and delete documents in spaces

Note: This method is deprecated. Use the direct URL method above instead.

Install the MCP client AND AI assistant rules in one command from your project folder:

# Navigate to your project directory first
cd /path/to/your/project

# Install for Cursor
npx @docuwriter-ai/mcp-client install cursor

# Install for Claude Desktop  
npx @docuwriter-ai/mcp-client install claude

# Install for VS Code
npx @docuwriter-ai/mcp-client install vscode

# Install for all environments
npx @docuwriter-ai/mcp-client install all

# Interactive installation (prompts you to choose)
npx @docuwriter-ai/mcp-client install

npm install -g @docuwriter-ai/mcp-client

git clone https://github.com/DocuWriter-ai/mcp-client.git
cd mcp-client
npm install
npm link

Environment-Specific AI Rules & MCP Configuration:

• Cursor:
  • AI Rules: .cursor/rules/docuwriter-mcp.mdc with alwaysApply: true
  • MCP Config: .cursor/mcp.json
• Claude Desktop:
  • AI Rules: CLAUDE.md (root directory)
  • MCP Config: .mcp.json
• VS Code:
  • MCP Config: .vscode/mcp.json (no AI rules support)

Smart AI Guidance:

• When and how to use DocuWriter.ai MCP tools effectively
• Best practices for code documentation workflows
• Smart tool selection for different scenarios
• Error handling and optimization strategies
• Complete workflow examples

Benefits:

• 🎯 Smarter tool usage - AI knows which tool to use for specific tasks
• 🔄 Complete workflows - AI can handle end-to-end documentation processes
• 🛡️ Error prevention - Built-in best practices prevent common issues
• 📈 Better results - Optimized prompts and strategies for higher quality output
• ⚡ Always applies - Rules are automatically applied to all conversations

⚠️ Use the direct URL method instead (see top of README)

The legacy NPM package method requires manual token configuration. We recommend using the direct URL method which handles authentication via OAuth automatically.

Get current user information from DocuWriter.ai.

Parameters: None

Example:

Use get_user_info to check my account status

Report feedback from the user on what would make DocuWriter.ai better.

Parameters:

• feedback (string, required): Detailed feedback from the user on what would make DocuWriter.ai better (minimum 10 characters)

Example:

Report feedback: "The MCP integration is great but I'd love to see support for more IDEs"

List all documentation spaces for the authenticated user.

Parameters: None

Example:

Show me all my documentation spaces

Search for documents within a specific documentation space.

Parameters:

• space_id (integer, required): ID of the space to search in
• query (string, required): Search query (minimum 2 characters)
• page (integer, optional): Page number for pagination (default: 1)
• per_page (integer, optional): Number of results per page (default: 20, max: 100)
• highlight (boolean, optional): Whether to highlight search terms (default: true)

Example:

Search for "authentication" in space 123

⚠️ Processing time notice: All generation tools use advanced AI models and typically take time to complete, depending on code complexity and file size. Please be patient during processing.

Generate comprehensive documentation for source code files.

Parameters:

• files (array, required): Array of file objects, each containing:

  • filename (string, required): Name of the file
  • source_code (string, required): Source code content

• output_language (string, optional): Language for documentation (default: "English")

• documentation_type (string, optional): Type of documentation to generate

• additional_instructions (string, optional): Additional instructions

• name (string, optional): Name for the generated documentation

Features:

• Multi-File Support: Process multiple files in a single request
• Smart Context: Analyzes relationships between files for comprehensive documentation

Example (Single File):

Generate documentation for this React component:
files: [{"filename": "UserProfile.jsx", "source_code": "[paste your code here]"}]
name: User Profile Component Documentation

Example (Multiple Files):

Generate documentation for this API:
files: [
  {"filename": "UserController.php", "source_code": "[controller code]"},
  {"filename": "UserModel.php", "source_code": "[model code]"},
  {"filename": "UserService.php", "source_code": "[service code]"}
]
documentation_type: API Documentation

Generate comprehensive test suites for source code.

Parameters:

• source_code (string, required): The source code to generate tests for
• filename (string, required): Name of the file to test
• test_type (string, optional): "Unit", "Integration", "Feature", or "All" (default: "Unit")
• test_framework (string, optional): Testing framework to use
• additional_instructions (string, optional): Additional instructions
• name (string, optional): Name for the generated tests

Example:

Generate unit tests for this function:
source_code: "[paste your code here]"
filename: calculator.js
test_framework: Jest
name: Calculator Function Tests

Generate optimized versions of source code.

Parameters:

• source_code (string, required): The source code to optimize
• filename (string, required): Name of the file to optimize
• optimization_focus (string, optional): "Performance", "Readability", "Security", "Memory", or "All" (default: "Performance")
• additional_instructions (string, optional): Additional optimization instructions
• name (string, optional): Name for the optimized code

Example:

Optimize this code for performance:
source_code: "[paste your code here]"
filename: data-processor.py
optimization_focus: Performance
name: Optimized Data Processor

Create a new document in a DocuWriter.ai space.

Parameters:

• space_id (string, required): The ID of the space to create the document in
• title (string, required): The title of the document
• content (string, required): The content of the document (markdown or plain text)
• type (string, optional): Content type - "blank" (default) or "markdown"
• parent_id (string, optional): The ID of the parent folder
• path (string, optional): Folder path for the document (e.g., "docs/api") - creates folders if they don't exist

Example:

Create a new document in space 123 with title "API Guide" and content "# API Guide\n\nThis is a comprehensive guide..."

Retrieve a specific document from a space.

Parameters:

• space_id (string, required): The ID of the space containing the document
• document_id (string, required): The ID of the document to retrieve

Response: Returns both markdown content and raw Editor.js format

Update an existing document in a space.

Parameters:

• space_id (string, required): The ID of the space containing the document
• document_id (string, required): The ID of the document to update
• title (string, required): The new title of the document
• content (string, required): The new content of the document
• type (string, optional): Content type - "blank" or "markdown"
• parent_id (string, optional): The ID of the parent folder (null to move to root)

Delete a document from a space.

Parameters:

• space_id (string, required): The ID of the space containing the document
• document_id (string, required): The ID of the document to delete

Response: Returns confirmation with deleted document details

Generate documentation using DocuWriter.ai AI and automatically add it to a space.

Parameters:

• space_id (string, required): The ID of the space to add the documentation to
• files (array, required): Array of file objects, each containing:
  • filename (string, required): Name of the file
  • source_code (string, required): Source code content of the file
• title (string, required): Title for the document in the space
• output_language (string, optional): Output language for documentation
• documentation_type (string, optional): Type of documentation to generate
• additional_instructions (string, optional): Additional instructions for documentation generation
• name (string, optional): Optional custom name for the generated documentation for better searchability
• parent_id (string, optional): The ID of the parent folder
• path (string, optional): Folder path for the document

Workflow: This tool handles the complete process from generation to space addition automatically.

Example (Single File):

Generate documentation for my API code and add it to my project space:
files: [{"filename": "UserController.php", "source_code": "[paste your code here]"}]
title: User Controller Documentation

Example (Multiple Files):

Generate documentation for my API and add it to my project space:
files: [
  {"filename": "UserController.php", "source_code": "[controller code]"},
  {"filename": "UserModel.php", "source_code": "[model code]"},
  {"filename": "UserService.php", "source_code": "[service code]"}
]
title: User API Documentation

All DocuWriter.ai generation tools use advanced AI models to analyze and process your code. Here's what to expect:

1. Optimize File Size: Keep individual files under 500KB for best performance
2. Use Multi-File Support: For related files, use the multi-file documentation tool instead of separate requests
3. Provide Clear Instructions: Specific additional instructions help the AI work more efficiently
4. Batch Similar Requests: Group related generation tasks together

• Code Analysis: AI analyzes your code structure, dependencies, and patterns
• Context Understanding: Builds comprehensive understanding of your codebase
• Generation: Creates high-quality, contextual output based on analysis
• Quality Assurance: Ensures output meets your specified requirements

• Don't Interrupt: Let the process complete to avoid partial results
• Check File Size: Large files (>1MB) may take longer to process
• Monitor Progress: The MCP client will show progress updates during generation
• Contact Support: If processing consistently takes >3 minutes, contact support

If you're currently using the NPM package, migration is simple:

1. Remove the old configuration from your MCP config file
2. Add the new URL-based configuration (see top of README)
3. Restart your IDE
4. Authorize via OAuth on first connection

Before (Deprecated):

{
  "mcpServers": {
    "docuwriter": {
      "command": "npx",
      "args": ["--yes", "@docuwriter-ai/mcp-client@latest", "start"],
      "env": {
        "DOCUWRITER_API_TOKEN": "your_token_here"
      }
    }
  }
}

After (Recommended):

{
  "mcpServers": {
    "docuwriter": {
      "url": "https://app.docuwriter.ai/mcp",
      "headers": {}
    }
  }
}

• ✅ No more API token management
• ✅ Automatic OAuth authentication
• ✅ No NPM dependencies
• ✅ Faster connection
• ✅ Always up-to-date

If you're using the recommended URL method and experiencing issues:

• Ensure you have an active DocuWriter.ai account
• Complete the OAuth authorization when prompted
• Restart your IDE after adding the configuration
• Check that your IDE supports HTTP/SSE MCP servers

If you're still using the deprecated NPM package:

• We recommend migrating to the URL method (see Migration section above)
• For token issues: Verify your DOCUWRITER_API_TOKEN is correct
• For permission issues: Check that your token has the necessary permissions

• Documentation: DocuWriter.ai Docs
• Issues: GitHub Issues
• Support: DocuWriter.ai Support

MIT License - see LICENSE file for details.