Deepwriter

🚀 Deep Writer

Deep Writer is a high - efficiency writing tool based on Node.js, designed to enhance writing productivity. It supports personalized settings through the command - line interface and configuration files to meet the needs of different users.

🚀 Quick Start

Deep Writer is a Node.js-based efficient writing tool designed to boost writing productivity. It supports personalized settings via the command - line interface and configuration files to meet diverse user needs.

📦 Installation

Install via npm

You can easily install Deep Writer using the Node Package Manager (npm):

npm install deep-writer

Clone the repository

Alternatively, you can directly clone the project repository from GitHub:

git clone https://github.com/deepwriter/deep-writer.git
cd deep-writer
npm install

📚 Documentation

Configuration Parameters

Deep Writer can be configured through command - line arguments or a configuration file. Here are the main supported options:

Command - line arguments

• --mode: Sets the running mode. Valid values are development or production.
• --port: Specifies the port that the service listens on. The default is 3000.
• --config: Specifies the path to the configuration file.

Configuration file

Create a file named deep-writer.config.js and set the following parameters in it:

module.exports = {
  mode: 'development',
  port: 3000,
  // Other custom configurations
}

API Reference

Deep Writer provides a rich API interface that allows developers to interact with its features. Here are the main API endpoints:

Text processing

• POST /api/process: Processes the input text and returns the result.

Configuration management

• GET /api/config: Retrieves the current configuration information.
• PUT /api/config: Updates the configuration parameters.

Troubleshooting

Common issues

1. API key issues

   • Ensure that the DeepWriter API key is correctly set in the .env file.
   • Check if the key has the required permissions.

2. Connection issues

   • Confirm that the Deep Writer service is running and accessible.
   • Check the network configuration to rule out interference from firewalls or proxies.

3. Protocol issues

   • Use a compatible MCP client.
   • Verify that the stdio transmission is correctly configured.
   • Ensure that the client supports the MCP protocol version 2025 - 03 - 26.

Debugging

You can enable detailed logging by setting the DEBUG environment variable:

DEBUG=deep-writer-mcp:* npm start

Contribution Guidelines

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

Submitting issues

1. Bug reports

   • Submit them using the GitHub issue tracker.
   • Provide detailed reproduction steps and environment information.
   • Include relevant logs and error messages.

2. Feature requests

   • Create a new issue with the "enhancement" label.
   • Clearly describe the feature and its use cases.
   • Explain its benefits to the project.

3. Security issues

   • Do not publicly disclose security vulnerability information.
   • Send an email to security@deepwriter.com.
   • We will assist in handling the vulnerability.

Submitting a Pull Request

1. Before you start

   • Check existing issues and PRs to avoid duplicate work.
   • For major changes, create an issue for discussion first.
   • Fork the repository and work on your own branch.

2. Submitting code

   • Ensure that your code follows the project's coding standards.
   • Provide clear commit messages.
   • Update relevant documentation and test cases.

Security Considerations

• Keep the software up - to - date to prevent security vulnerabilities.
• Avoid running unvalidated code in untrusted environments.
• Configure the service following the principle of least privilege.

📄 License

Deep Writer is licensed under the MIT License. Please refer to the LICENSE file for specific terms.