The DeepWriter MCP Server allows users to interact with DeepWriter's AI for project management and content generation via the MCP protocol. It offers several capabilities:
Project Management: Create, list, update, and delete projects
Content Generation: Generate content for projects using DeepWriter's AI
Detailed Project Access: Retrieve specific information about projects
MCP Integration: Works seamlessly with Claude and other MCP-compatible AI assistants
The server adheres to MCP protocol standards, ensuring standardized interaction between users and DeepWriter's AI tools.
Offers a Discord community for contributors to get help and engage with the project.
Supports environment variable configuration through .env files for storing API keys and other configuration settings.
Uses ESLint for code style enforcement and static analysis as part of development guidelines.
Uses GitHub for issue tracking, bug reports, feature requests, and pull requests via its repository.
Provides specific configuration instructions for macOS systems when connecting to Claude for Desktop.
Runs as a Node.js application, requiring v17 or higher for proper functionality.
Uses npm (v6 or higher) for package management and dependency installation.
Incorporates Prettier for consistent code formatting according to development guidelines.
Built with TypeScript, providing type safety and modern JavaScript features.
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
Clone the repository:
git clone https://github.com/yourusername/deepwriter-mcp.git cd deepwriter-mcpInstall dependencies:
npm installCreate a
.env
file in the root directory with your DeepWriter API key:DEEPWRITER_API_KEY=your_api_key_hereBuild the project:
npm run build
Usage
Starting the Server
Start the MCP server:
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:
Open your Claude for Desktop configuration file:
macOS:
~/Library/Application Support/Claude/claude_desktop_config.json
Windows:
%APPDATA%\Claude\claude_desktop_config.json
Add the server configuration:
{ "mcpServers": { "deepwriter": { "command": "node", "args": ["/ABSOLUTE/PATH/TO/deepwriter-mcp/build/index.js"], "env": { "DEEPWRITER_API_KEY": "your_api_key_here" } } } }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.
2. getProjectDetails
Retrieves detailed information about a specific project.
3. createProject
Creates a new project with the specified title and email.
4. updateProject
Updates an existing project with the specified changes.
5. generateWork
Generates content for a project using DeepWriter's AI.
6. deleteProject
Deletes a project.
Development
Project Structure
Building
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:
or
TypeScript Configuration
The project uses TypeScript with ES modules and Node16 module resolution. Key TypeScript settings:
Troubleshooting
Common Issues
API Key Issues:
Ensure your DeepWriter API key is correctly set in the
.env
fileCheck that the API key is being passed correctly in tool arguments
Verify the API key has the necessary permissions
Connection Problems:
Make sure the DeepWriter API is accessible from your network
Check for any firewall or proxy settings that might block connections
Verify your network connection is stable
MCP Protocol Issues:
Ensure you're using a compatible MCP client
Check that the stdio transport is properly configured
Verify the client supports protocol version 2025-03-26
Parameter Naming:
The server supports both snake_case (
project_id
) and camelCase (projectId
) parameter namesAll parameters are case-sensitive
Required parameters must not be null or undefined
Debugging
For detailed logs, run the server with the DEBUG environment variable:
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
Bug Reports
Use the GitHub issue tracker
Include detailed steps to reproduce the bug
Provide your environment details (Node.js version, OS, etc.)
Include relevant logs and error messages
Use the bug report template provided
Feature Requests
Use the GitHub issue tracker with the "enhancement" label
Clearly describe the feature and its use case
Explain how it benefits the project
Use the feature request template provided
Security Issues
For security vulnerabilities, please DO NOT create a public issue
Email security@deepwriter.com instead
We'll work with you to address the vulnerability
We follow responsible disclosure practices
Pull Requests
Before Starting
Check existing issues and PRs to avoid duplicate work
For major changes, open an issue first to discuss
Read our coding standards and MCP implementation guidelines
Development Process
Fork the repository
Create a new branch from
main
Follow our coding style and conventions
Add tests for new features
Update documentation as needed
PR Requirements
Include a clear description of changes
Link related issues
Add or update tests
Update documentation
Follow commit message conventions
Sign the Contributor License Agreement (CLA)
Code Review
All PRs require at least one review
Address review feedback
Keep PRs focused and reasonable in size
Be responsive to questions and comments
Development Guidelines
Code Style
Follow TypeScript best practices
Use ESLint with our configuration
Format code with Prettier
Follow MCP protocol specifications
Testing
Write unit tests for new features
Maintain or improve test coverage
Test MCP protocol compliance
Test with multiple Node.js versions
Documentation
Update README.md for user-facing changes
Add JSDoc comments for new code
Update API documentation
Include examples for new features
Commit Messages
Follow conventional commits format
Reference issues where appropriate
Keep commits focused and atomic
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
hybrid server
The server is able to function both locally and remotely, depending on the configuration or use case.
Provides tools for creating, managing, and generating content for DeepWriter projects through a standardized Model Context Protocol interface.
Related MCP Servers
- AsecurityAlicenseAqualityA Model Context Protocol server that provides tools for code modification and generation via Large Language Models, allowing users to create, modify, rewrite, and delete files using structured XML instructions.Last updated -122MIT License
- AsecurityAlicenseAqualityA comprehensive Model Context Protocol server that provides advanced Node.js development tooling for automating project creation, component generation, package management, and documentation with AI-powered assistance.Last updated -75MIT License
Appwrite MCP Serverofficial
AsecurityAlicenseAqualityA Model Context Protocol server that allows AI assistants to interact with Appwrite's API, providing tools to manage databases, users, functions, teams, and other resources within Appwrite projects.Last updated -54MIT License- -securityFlicense-qualityA utility module for creating Model Context Protocol servers declaratively, allowing developers to easily define tools, prompts, and resources with a simplified syntax.Last updated -1