深度写入器-mcp

Name: 深度写入器-mcp
Author: deepwriter-ai

作者：deepwriter-ai6 星标更新：2025-10-05

安装使用来源：spider==github.com

项目介绍

DeepWriter MCP 服务器

官方网站: DeepWriter.com

附加文档: DeepWriter API 访问文档

一个用于与 DeepWriter API 交互的模型上下文协议（MCP）服务器。此服务器提供了创建、管理和生成 DeepWriter 项目内容的工具，通过标准化的 MCP 接口进行操作。

功能

项目管理: 创建、列出、更新和删除项目
内容生成: 使用 DeepWriter 的 AI 生成项目内容
项目详情: 获取项目的详细信息
MCP 集成: 无缝集成到 Claude 和其他兼容 MCP 的 AI 助手中
标准 MCP 特性: 实现 MCP 协议版本 2025-03-26
传输支持: 用于本地进程通信的 Stdio 传输

先决条件

Node.js (v17 或更高版本)
npm (v6 或更高版本)
DeepWriter API 密钥
一个兼容 MCP 的客户端（例如，桌面版 Claude）

安装

通过 Smithery 安装

要通过 Smithery 自动安装 deepwriter-mcp 到桌面版 Claude：

npx -y @smithery/cli install @deepwriter-ai/deepwriter-mcp --client claude

手动安装

克隆仓库：

git clone https://github.com/yourusername/deepwriter-mcp.git
cd deepwriter-mcp

安装依赖项：
```
npm install
```
在根目录下创建一个 .env 文件，并添加您的 DeepWriter API 密钥：
```
DEEPWRITER_API_KEY=your_api_key_here
```
构建项目：
```
npm run build
```

使用方法

启动服务器

启动 MCP 服务器：

node build/index.js

该服务器将在标准输入中监听 MCP 请求，并在标准输出中响应，遵循 MCP stdio 传输规范。

连接到桌面版 Claude

要使用 DeepWriter MCP 服务器与桌面版 Claude 一起使用：

打开您的桌面版 Claude 配置文件：
- macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
- Windows: %APPDATA%\Claude\claude_desktop_config.json

添加服务器配置：

{
  "mcpServers": {
    "deepwriter": {
      "command": "node",
      "args": ["/ABSOLUTE/PATH/TO/deepwriter-mcp/build/index.js"],
      "env": {
        "DEEPWRITER_API_KEY": "your_api_key_here"
      }
    }
  }
}

重启桌面版 Claude 以加载新配置。

MCP 协议支持

此服务器实现了 MCP 协议版本 2025-03-26，具有以下功能：

传输: 用于本地进程通信的 Stdio 传输
工具: 完整支持所有 DeepWriter API 操作
日志: 可配置级别的结构化日志

可用工具

1. listProjects

列出与您的 DeepWriter 账户关联的所有项目。

{
  "api_key": "your_api_key_here"
}

2. getProjectDetails

获取特定项目的详细信息。

{
  "api_key": "your_api_key_here",
  "project_id": "your_project_id_here"
}

3. createProject

使用指定的标题和电子邮件创建一个新的项目。

{
  "api_key": "your_api_key_here",
  "title": "Your Project Title",
  "email": "your_email@example.com"
}

4. updateProject

更新现有项目并应用指定的更改。

{
  "api_key": "your_api_key_here",
  "project_id": "your_project_id_here",
  "updates": {
    "title": "Updated Project Title",
    "prompt": "Updated project prompt",
    "author": "Updated author name",
    "email": "updated@email.com",
    "model": "Updated model name",
    "outline_text": "Updated outline",
    "style_text": "Updated style guide",
    "supplemental_info": "Updated additional information",
    "work_description": "Updated work description",
    "work_details": "Updated work details",
    "work_vision": "Updated work vision"
  }
}

5. generateWork

使用 DeepWriter 的 AI 为项目生成内容。

{
  "api_key": "your_api_key_here",
  "project_id": "your_project_id_here",
  "is_default": true // 可选，默认为 true
}

6. deleteProject

删除项目。

{
  "api_key": "your_api_key_here",
  "project_id": "your_project_id_here"
}

开发

项目结构

deepwriter-mcp/
├── src/
│   ├── index.ts              # 主入口点和 MCP 服务器设置
│   ├── api/
│   │   └── deepwriterClient.ts  # DeepWriter API 客户端
│   └── tools/                # MCP 工具实现
│       ├── createProject.ts
│       ├── deleteProject.ts
│       ├── generateWork.ts
│       ├── getProjectDetails.ts
│       ├── listProjects.ts
│       └── updateProject.ts
├── build/                    # 编译后的 JavaScript 输出
├── test-deepwriter-tools.js  # 工具测试脚本
├── test-mcp-client.js       # MCP 客户端测试脚本
└── tsconfig.json            # TypeScript 配置

构建

npm run build

这将把 TypeScript 代码编译到 build 目录中的 JavaScript 中。

测试

您可以使用提供的测试脚本在本地测试 MCP 服务器：

node test-mcp-client.js

或

node test-deepwriter-tools.js

TypeScript 配置

该项目使用 TypeScript，采用 ES 模块和 Node16 模块解析。关键的 TypeScript 设置如下：

{
  "compilerOptions": {
    "target": "ES2022",
    "module": "Node16",
    "moduleResolution": "Node16",
    "outDir": "./build",
    "strict": true
  }
}

故障排除

常见问题

API 密钥问题：
- 确保您的 DeepWriter API 密钥正确设置在 .env 文件中
- 检查 API 密钥是否正确传递到工具参数中
- 验证 API 密钥具有必要的权限
连接问题：
- 确保从您的网络可以访问 DeepWriter API
- 检查任何可能阻止连接的防火墙或代理设置
- 验证您的网络连接稳定
MCP 协议问题：
- 确保您使用的是兼容的 MCP 客户端
- 检查 stdio 传输是否正确配置
- 验证客户端支持协议版本 2025-03-26
参数命名：
- 服务器支持 snake_case (project_id) 和 camelCase (projectId) 参数名称
- 所有参数都是大小写敏感的
- 必需参数不能为 null 或 undefined

调试

为了获得详细的日志，请使用 DEBUG 环境变量运行服务器：

DEBUG=deepwriter-mcp:* node build/index.js

您还可以检查桌面版 Claude 的日志：

macOS: ~/Library/Logs/Claude/mcp*.log
Windows: %APPDATA%\Claude\logs\mcp*.log

贡献

我们欢迎来自社区的贡献！以下是您可以如何帮助的方法：

提交问题

错误报告
- 使用 GitHub 问题跟踪器
- 包括详细的步骤来复现错误
- 提供您的环境细节（Node.js 版本、操作系统等）
- 包含相关的日志和错误消息
- 使用提供的错误报告模板
功能请求
- 使用带有“enhancement”标签的 GitHub 问题跟踪器
- 清晰描述功能及其使用场景
- 解释其如何使项目受益
- 使用提供的功能请求模板
安全问题
- 对于安全漏洞，请不要公开创建问题
- 而是发送邮件至 security@deepwriter.com
- 我们会与您合作解决漏洞
- 我们遵循负责任披露实践

拉取请求

开始前
- 检查现有的问题和 PR 以避免重复工作
- 对于重大变更，先打开一个问题进行讨论
- 阅读我们的编码标准和 MCP 实现指南
开发过程
- 分叉仓库
- 从 main 分支创建一个新的分支
- 遵循我们的编码风格和约定
- 为新特性编写测试
- 根据需要更新文档
PR 要求
- 包括清晰的变化描述
- 关联相关的问题
- 添加或更新测试
- 更新文档
- 遵循提交消息约定
- 签署贡献者许可协议（CLA）
代码审查
- 所有 PR 需要至少一次审查
- 回应审查反馈
- 保持 PR 集中且合理规模
- 对问题和评论作出响应

开发指南

代码风格
- 遵循 TypeScript 最佳实践
- 使用带有我们配置的 ESLint
- 使用 Prettier 格式化代码
- 遵循 MCP 协议规范
测试
- 为新特性编写单元测试
- 维护或提高测试覆盖率
- 测试 MCP 协议合规性
- 使用多个 Node.js 版本进行测试
文档
- 更新 README.md 以反映用户界面变化
- 为新代码添加 JSDoc 注释
- 更新 API 文档
- 为新特性提供示例
提交消息
- 遵循常规提交格式
- 在适当的地方引用问题
- 保持提交集中且原子化
- 使用清晰、描述性的消息

获取帮助

加入我们的 Discord 社区
查看文档
在 GitHub 讨论中提问
参加每月一次的贡献者电话会议

安全

服务器在处理之前验证所有输入
API 密钥绝不会被记录或暴露在错误消息中
stdio 传输提供进程隔离
所有外部 API 调用均使用 HTTPS
输入验证防止注入攻击

许可证

MIT