Inked (Writing Assistant)

🚀 Seal - A Long-Text Writing Tool

Seal is a powerful draft-writing tool designed for novelists, report writers, and anyone engaged in long-text creation. It offers an intuitive interface to create, revise, and finalize drafts with the assistance of Claude.

🚀 Quick Start

✨ Features

Prickly - Draft Management

• Create and manage content drafts through natural conversations with Claude.
• Automated version control with a unique ID for each draft.
• Persistent storage in a PostgreSQL or SQLite database.
• Flexible draft organization and retrieval capabilities.

Printing - Content Generation

• Transform drafts into polished long-text content.
• Organize books and long documents by chapters.
• Support for custom draft versions (e.g., Chapter 1, Version 1).
• Multiple output formats are supported:
  • Markdown (.md)
  • Plain text (.txt)
  • Microsoft Word (.docx)
  • Apple Pages (.pages)

📦 Installation

# Clone the repository
git clone https://github.com/frgmt0/mcp-inked.git
cd mcp-inked

# Install dependencies
npm install

# Build the project
npm run build

💻 Usage Examples

Basic Usage

"Hey Claude, I want to write a report on annual sales data."

Claude will create a new draft with a unique ID and help you organize your thoughts.

"Let's create Chapter 1, Version 1 with the ID ch01-d1."

Drafts can be organized by chapters and iteratively optimized through version control.

"Please convert my draft into a Markdown file."

Claude will compile your draft and output it in the format you choose, ready for further editing.

Advanced Usage

const { Inked } = require('inked');
const inked = new Inked({
  database: {
    type: 'sqlite',
    connection: {
      filename: 'my_project.db'
    }
  }
});

// Create a new draft
inked.createDraft('My Report', (err, draft) => {
  if (err) return console.error(err);
  console.log(`Draft "${draft.title}" has been created with ID ${draft.id}`);
});

// Load an existing draft
inked.loadDraft('ch01-d1', (err, draft) => {
  if (err) return console.error(err);
  
  // Add content to the chapter
  draft.content.chapter1 = "## Chapter 1: Introduction\nHere will be a detailed introduction to the project background.";
  
  // Save the draft
  inked.saveDraft(draft.id, (err) => {
    if (err) return console.error(err);
    console.log("Draft has been saved");
  });
});

// Export to Markdown
inked.exportTo('md', 'my_report.md', (err, content) => {
  if (err) return console.error(err);
  console.log("Successfully exported to Markdown file");
});

// Export to Word document
inked.exportTo('docx', 'my_report.docx', (err, content) => {
  if (err) return console.error(err);
  console.log("Successfully exported to Word file");
});

📚 Documentation

Configuration

Create a config.json file in the project root directory to customize settings:

{
  "database": {
    "type": "sqlite",  // or "postgres"
    "connection": {
      "filename": "inked.db",  // for SQLite
      // for PostgreSQL:
      // "host": "localhost",
      // "port": 5432,
      // "database": "inked",
      // "username": "user",
      // "password": "pass"
    }
  },
  "defaultFormat": "md",
  "storage": {
    "draftsPath": "./drafts",
    "outputPath": "./output"
  }
}

Database Options

1. SQLite (default)
   • Lightweight, file-based database.
   • Ideal for single-user environments.
   • No additional setup required.
2. PostgreSQL
   • Powerful, supports multiple users.
   • Suitable for large projects.
   • Requires a PostgreSQL server.

Output Formats

1. Markdown (.md)
   • Default format.
   • Suitable for version control.
   • Supports basic formatting.
   • Includes YAML front matter.
2. Plain text (.txt)
   • Simple and straightforward plain text output.
   • No additional formatting.
3. Microsoft Word (.docx)
   • Generates an editable Word document.
   • Supports complex layout.
4. Apple Pages (.pages)
   • Generates a file suitable for Apple Pages.
   • Supports iWork format.

For more detailed information, please refer to the official project documentation:

• Configuration Guide
• API Documentation
• Usage Tutorial

📄 License

The Seal tool provides great convenience for long-text writing with its powerful draft management and flexible content output capabilities. Whether it's a novel, a report, or other types of documents, Seal can help you complete your writing tasks efficiently.