DeepWriter MCP Server

A Model Context Protocol (MCP) server for interacting with the DeepWriter API. This server provides tools for creating, managing, and generating content for DeepWriter projects through the standardized MCP interface.

Features

• Project Management: Create, list, update, and delete projects
• Content Generation: Generate content for projects using DeepWriter's AI
• Project Details: Retrieve detailed information about projects
• MCP Integration: Seamlessly integrate with Claude and other MCP-compatible AI assistants
• Standard MCP Features: Implements MCP protocol version 2025-03-26
• Transport Support: Stdio transport for local process communication

Prerequisites

• Node.js (v17 or higher)
• npm (v6 or higher)
• DeepWriter API key
• An MCP-compatible client (e.g., Claude for Desktop)

Installation

Installing via Smithery

To install deepwriter-mcp for Claude Desktop automatically via Smithery:

npx -y @smithery/cli install @deepwriter-ai/deepwriter-mcp --client claude

Manual Installation

1. Clone the repository: bash git clone https://github.com/yourusername/deepwriter-mcp.git cd deepwriter-mcp

2. Install dependencies: bash npm install

3. Create a .env file in the root directory with your DeepWriter API key: DEEPWRITER_API_KEY=your_api_key_here

4. Build the project: bash npm run build

Usage

Starting the Server

Start the MCP server:

node build/index.js

The server will listen on stdin for MCP requests and respond on stdout, following the MCP stdio transport specification.

Connecting to Claude for Desktop

To use the DeepWriter MCP server with Claude for Desktop:

1. Open your Claude for Desktop configuration file:
2. macOS: ~/Library/Application Support/Claude/claude_desktop_config.json

3. Windows: %APPDATA%\Claude\claude_desktop_config.json

4. Add the server configuration: json { "mcpServers": { "deepwriter": { "command": "node", "args": ["/ABSOLUTE/PATH/TO/deepwriter-mcp/build/index.js"], "env": { "DEEPWRITER_API_KEY": "your_api_key_here" } } } }

5. Restart Claude for Desktop to load the new configuration.

MCP Protocol Support

This server implements MCP protocol version 2025-03-26 with the following capabilities:

• Transport: Stdio transport for local process communication
• Tools: Full support for all DeepWriter API operations
• Logging: Structured logging with configurable levels

Available Tools

1. listProjects

Lists all projects associated with your DeepWriter account.

{
  "api_key": "your_api_key_here"
}

2. getProjectDetails

Retrieves detailed information about a specific project.

{
  "api_key": "your_api_key_here",
  "project_id": "your_project_id_here"
}

3. createProject

Creates a new project with the specified title and email.

{
  "api_key": "your_api_key_here",
  "title": "Your Project Title",
  "email": "your_email@example.com"
}

4. updateProject

Updates an existing project with the specified changes.

{
  "api_key": "your_api_key_here",
  "project_id": "your_project_id_here",
  "updates": {
    "title": "Updated Project Title",
    "prompt": "Updated project prompt",
    "author": "Updated author name",
    "email": "updated@email.com",
    "model": "Updated model name",
    "outline_text": "Updated outline",
    "style_text": "Updated style guide",
    "supplemental_info": "Updated additional information",
    "work_description": "Updated work description",
    "work_details": "Updated work details",
    "work_vision": "Updated work vision"
  }
}

5. generateWork

Generates content for a project using DeepWriter's AI.

{
  "api_key": "your_api_key_here",
  "project_id": "your_project_id_here",
  "is_default": true // Optional, defaults to true
}

6. deleteProject

Deletes a project.

{
  "api_key": "your_api_key_here",
  "project_id": "your_project_id_here"
}

Development

Project Structure

deepwriter-mcp/
├── src/
│   ├── index.ts              # Main entry point and MCP server setup
│   ├── api/
│   │   └── deepwriterClient.ts  # DeepWriter API client
│   └── tools/                # MCP tool implementations
│       ├── createProject.ts
│       ├── deleteProject.ts
│       ├── generateWork.ts
│       ├── getProjectDetails.ts
│       ├── listProjects.ts
│       └── updateProject.ts
├── build/                    # Compiled JavaScript output
├── test-deepwriter-tools.js  # Tool testing script
├── test-mcp-client.js       # MCP client testing script
└── tsconfig.json            # TypeScript configuration

Building

npm run build

This will compile the TypeScript code into JavaScript in the build directory.

Testing

You can test the MCP server locally using the provided test scripts:

node test-mcp-client.js

or

node test-deepwriter-tools.js

TypeScript Configuration

The project uses TypeScript with ES modules and Node16 module resolution. Key TypeScript settings:

{
  "compilerOptions": {
    "target": "ES2022",
    "module": "Node16",
    "moduleResolution": "Node16",
    "outDir": "./build",
    "strict": true
  }
}

Troubleshooting

Common Issues

1. API Key Issues:
2. Ensure your DeepWriter API key is correctly set in the .env file
3. Check that the API key is being passed correctly in tool arguments

4. Verify the API key has the necessary permissions

5. Connection Problems:

6. Make sure the DeepWriter API is accessible from your network
7. Check for any firewall or proxy settings that might block connections

8. Verify your network connection is stable

9. MCP Protocol Issues:

10. Ensure you're using a compatible MCP client
11. Check that the stdio transport is properly configured

12. Verify the client supports protocol version 2025-03-26

13. Parameter Naming:

14. The server supports both snake_case (project_id) and camelCase (projectId) parameter names
15. All parameters are case-sensitive
16. Required parameters must not be null or undefined

Debugging

For detailed logs, run the server with the DEBUG environment variable:

DEBUG=deepwriter-mcp:* node build/index.js

You can also check Claude for Desktop logs at: - macOS: ~/Library/Logs/Claude/mcp*.log - Windows: %APPDATA%\Claude\logs\mcp*.log

Contributing

We welcome contributions from the community! Here's how you can help:

Submitting Issues

1. Bug Reports
2. Use the GitHub issue tracker
3. Include detailed steps to reproduce the bug
4. Provide your environment details (Node.js version, OS, etc.)
5. Include relevant logs and error messages

6. Use the bug report template provided

7. Feature Requests

8. Use the GitHub issue tracker with the "enhancement" label
9. Clearly describe the feature and its use case
10. Explain how it benefits the project

11. Use the feature request template provided

12. Security Issues

13. For security vulnerabilities, please DO NOT create a public issue
14. Email security@deepwriter.com instead
15. We'll work with you to address the vulnerability
16. We follow responsible disclosure practices

Pull Requests

1. Before Starting
2. Check existing issues and PRs to avoid duplicate work
3. For major changes, open an issue first to discuss

4. Read our coding standards and MCP implementation guidelines

5. Development Process

6. Fork the repository
7. Create a new branch from main
8. Follow our coding style and conventions
9. Add tests for new features

10. Update documentation as needed

11. PR Requirements

12. Include a clear description of changes
13. Link related issues
14. Add or update tests
15. Update documentation
16. Follow commit message conventions

17. Sign the Contributor License Agreement (CLA)

18. Code Review

19. All PRs require at least one review
20. Address review feedback
21. Keep PRs focused and reasonable in size
22. Be responsive to questions and comments

Development Guidelines

1. Code Style
2. Follow TypeScript best practices
3. Use ESLint with our configuration
4. Format code with Prettier

5. Follow MCP protocol specifications

6. Testing

7. Write unit tests for new features
8. Maintain or improve test coverage
9. Test MCP protocol compliance

10. Test with multiple Node.js versions

11. Documentation

12. Update README.md for user-facing changes
13. Add JSDoc comments for new code
14. Update API documentation

15. Include examples for new features

16. Commit Messages

17. Follow conventional commits format
18. Reference issues where appropriate
19. Keep commits focused and atomic
20. Use clear, descriptive messages

Getting Help

• Join our Discord community
• Check the documentation
• Ask questions in GitHub discussions
• Attend our monthly contributor calls

Security

• The server validates all inputs before processing
• API keys are never logged or exposed in error messages
• The stdio transport provides process isolation
• All external API calls use HTTPS
• Input validation prevents injection attacks

License

MIT