🚀 印章 - 长文本创作工具
印章是一款专为小说家、报告撰写者以及所有从事长文本创作的人打造的强大草稿绘制工具。它提供直观界面，借助Claude的能力，可实现草稿的创建、修订与最终定稿，极大提升长文本创作的效率与质量。
🚀 快速开始
要使用印章工具，你需要按照以下步骤进行安装和配置。
安装步骤
# 克隆仓库
git clone https://github.com/frgmt0/mcp-inked.git
cd mcp-inked
# 安装依赖
npm install
# 构建项目
npm run build
配置说明
在项目根目录下创建一个 config.json 文件以自定义设置：
{
"database": {
"type": "sqlite", // 或者 "postgres"
"connection": {
"filename": "inked.db", // 对于SQLite
// 对于PostgreSQL：
// "host": "localhost",
// "port": 5432,
// "database": "inked",
// "username": "user",
// "password": "pass"
}
},
"defaultFormat": "md",
"storage": {
"draftsPath": "./drafts",
"outputPath": "./output"
}
}
数据库选项
- SQLite（默认）：轻量级，基于文件的数据库，是单用户环境的理想选择，无需额外设置。
- PostgreSQL：强大，支持多用户，适合大型项目，但需要PostgreSQL服务器。
输出格式
- Markdown (.md)：默认格式，适用于版本控制，支持基本格式，包含YAML前置元数据。
- 纯文本 (.txt)：简单直接的纯文本输出，无任何额外格式。
- 微软Word (.docx)：生成可编辑的Word文档，支持复杂排版。
- 苹果Pages (.pages)：生成适用于苹果Pages的文件，支持iWork格式。
✨ 主要特性
刺毛 - 草稿管理
- 自然对话创作：通过自然对话与Claude一起创建和管理内容草稿。
- 自动化版本控制：每个草稿都有唯一ID，实现自动化版本控制。
- 持久存储：在PostgreSQL或SQLite数据库中持久存储草稿。
- 灵活组织检索：具备灵活的草稿组织和检索功能。
印染 - 内容生成
- 内容转化：将草稿转化为 polished 长文本内容。
- 章节组织：以章节为基础组织书籍和长文档。
- 自定义版本：支持自定义草稿版本（例如：第1章第1版）。
- 多格式输出：支持多种输出格式，如Markdown (.md)、纯文本 (.txt)、微软Word (.docx)、苹果Pages (.pages)。
💻 使用示例
基础用法
草稿创建
"Hey Claude, 我想写一份关于年度销售数据的报告。"
Claude 将会创建一个具有唯一ID的新草稿，并帮助你整理思路。
章节管理
"让我们创建第1章第1版，ID为 ch01-d1"
草稿可以通过章节进行组织，并通过版本控制实现迭代优化。
内容生成
"请将我的草稿转化为一个Markdown文件。"
Claude 将会编译你的草稿并以你选择的格式输出，准备好进一步编辑。
高级用法
安装并运行工具
# 克隆仓库并安装依赖
git clone https://github.com/frgmt0/mcp-inked.git
cd mcp-inked
npm install
npm start
创建新项目
const { Inked } = require('inked');
const inked = new Inked({
database: {
type: 'sqlite',
connection: {
filename: 'my_project.db'
}
}
});
// 创建新草稿
inked.createDraft('我的报告', (err, draft) => {
if (err) return console.error(err);
console.log(`草稿"${draft.title}"已创建，ID为 ${draft.id}`);
});
编辑和保存草稿
// 加载现有草稿
inked.loadDraft('ch01-d1', (err, draft) => {
if (err) return console.error(err);
// 添加内容到章节
draft.content.chapter1 = "## 第一章：介绍\n这里将详细介绍项目背景。";
// 保存草稿
inked.saveDraft(draft.id, (err) => {
if (err) return console.error(err);
console.log("草稿已保存");
});
});
导出为不同格式
// 导出为Markdown
inked.exportTo('md', 'my_report.md', (err, content) => {
if (err) return console.error(err);
console.log("导出为Markdown文件成功");
});
// 导出为Word文档
inked.exportTo('docx', 'my_report.docx', (err, content) => {
if (err) return console.error(err);
console.log("导出为Word文件成功");
});
📚 详细文档
如需更多详细信息，请参考项目官方文档：
结束语
印章工具通过强大的草稿管理和灵活的内容输出功能，为长文本创作提供了极大的便利。无论是小说、报告还是其他类型的文档，印章都能帮助你高效完成创作任务。