使用说明

项目简介

Inked 是一个基于 Model Context Protocol (MCP) 构建的写作辅助工具后端服务，旨在帮助小说家、报告撰写者以及任何需要处理长篇内容的用户。它通过 Claude 的辅助，提供直观的界面来起草、修订和最终确定书面内容。作为一个MCP服务器，Inked 能够与支持 MCP 协议的 LLM 客户端协同工作，为内容创作应用提供强大的后端支持。

主要功能点

草稿管理 (Quilling): 通过自然语言指令创建和管理内容草稿。支持草稿的版本控制和持久化存储，可以选择 SQLite 或 PostgreSQL 数据库。
内容生成 (Inking): 将草稿转换为多种格式的最终内容，如 Markdown、纯文本等。支持章节式组织和自定义版本控制，方便用户迭代优化文档。
灵活的配置: 支持 SQLite 和 PostgreSQL 数据库，以及 Markdown 和纯文本等多种输出格式。未来计划支持 Microsoft Word 和 Apple Pages 格式。

安装步骤

克隆仓库:

git clone https://github.com/frgmt0/mcp-inked.git
cd mcp-inked

安装依赖:
```
npm install
```
构建项目:
```
npm run build
```

服务器配置

Inked 服务器需要一个 'config.json' 文件进行配置。请在项目根目录下创建 'config.json' 文件，并根据需要修改以下配置项。

{
  "database": {
    "type": "sqlite",  // 数据库类型，可选 "sqlite" 或 "postgres"
    "connection": {
      "filename": "inked.db"  // SQLite 数据库文件名 (当 type 为 "sqlite" 时)
      // PostgreSQL 连接配置 (当 type 为 "postgres" 时):
      // "host": "localhost",
      // "port": 5432,
      // "database": "inked",
      // "username": "user",
      // "password": "pass"
    }
  },
  "defaultFormat": "md", // 默认输出格式，可选 "md" 或 "txt"
  "storage": {
    "draftsPath": "./drafts", // 草稿存储路径
    "outputPath": "./output"  // 输出文件存储路径
  }
}

MCP 客户端配置

要将 Inked 服务器配置为 MCP 客户端的后端服务，您需要配置客户端的服务器连接信息。以下是一个示例 JSON 配置，您需要将其添加到您的 MCP 客户端配置中。

{
  "servers": [
    {
      "server_name": "inked",  // 服务器名称，客户端通过此名称调用 Inked 服务器
      "command": "npm",      // 启动服务器的命令，这里使用 npm
      "args": ["start"]       // 启动服务器命令的参数，这里使用 "start" 运行 npm start 命令
    }
  ]
}

注意: 确保 MCP 客户端在启动时能够找到 'config.json' 配置文件以及 'node_modules' 依赖包。通常情况下，您需要在 Inked 项目的根目录下启动 MCP 客户端，或者配置客户端的工作目录为 Inked 项目根目录。

基本使用方法

启动服务器: 在项目根目录下运行以下命令启动 Inked MCP 服务器：
```
npm start
```
服务器成功启动后，将通过 stdio 等待接收来自 MCP 客户端的请求。
使用 MCP 客户端与 Inked 服务器交互: 您可以使用任何支持 MCP 协议的 LLM 客户端与 Inked 服务器进行交互。以下是一些基本操作示例（这些操作需要在 MCP 客户端中发起）：
- 创建草稿: 通过客户端向 Inked 服务器发送指令，例如 "Hey Claude, I want to write a report about my findings in the annual sales data."，服务器将创建一个新的草稿并返回草稿 ID。
- 管理章节: 使用指令例如 "Let's create chapter 1 draft 1 with ID ch01-d1" 来创建带有特定 ID 的章节草稿。
- 生成内容: 使用指令例如 "Please ink my drafts into a markdown file" 指示服务器将草稿编译成 Markdown 文件。服务器将根据您的草稿内容生成 Markdown 文件并保存到配置的输出路径。
- 列出草稿: 使用指令查询草稿列表，可以根据类型或父 ID 进行过滤。
请参考 MCP 客户端的文档，了解如何配置和使用 MCP 服务器，以及如何通过客户端向 Inked 服务器发送指令来完成上述操作。

关键词