AI导哈

内容生成服务器

DeepWriter MCP服务器是一个用于与DeepWriter API交互的模型上下文协议服务器，提供创建、管理和生成DeepWriter项目内容的工具。

  • by deepwriter-ai
  • TypeScript
  • 本地部署
  • 6 星标
  • 更新于
在 GitHub 查看 deepwriter-ai/deepwriter-mcp

使用说明

DeepWriter MCP服务器

官方网站： DeepWriter.com

附加文件： DeepWriter API访问文档

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

特性

  • 项目管理：创建、列出、更新和删除项目
  • 内容生成：使用DeepWriter的AI为项目生成内容
  • 项目详细信息：检索有关项目的详细信息
  • MCP集成：与Claude和其他兼容MCP的AI助手无缝集成
  • 标准MCP功能：实施MCP协议版本2025-03-26
  • 运输支持：用于本地过程通信的标准传输

先决条件

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

安装

通过Smithery安装

通过以下方式自动为Claude Desktop安装deepwriter mcp 铁匠铺:

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

手动安装

  1. 克隆存储库：

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

  2. 安装依赖项：

    npm install

  3. 创建一个 .env 根目录中使用DeepWriter API密钥的文件：

    DEEPWRITER_API_KEY=your_api_key_here

  4. 构建项目：

    npm run build

用法

启动服务器

启动MCP服务器：

node build/index.js

服务器将在stdin上监听MCP请求，并在stdout上响应，遵循MCP stdio传输规范。

连接到Claude for Desktop

要将DeepWriter MCP服务器与Claude for Desktop一起使用，请执行以下操作：

  1. 打开Claude for Desktop配置文件：

    • macOS： ~/Library/Application Support/Claude/claude_desktop_config.json
    • 窗户： %APPDATA%\Claude\claude_desktop_config.json

  2. 添加服务器配置：

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

  3. 重新启动Claude for Desktop以加载新配置。

MCP协议支持

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

  • 运输：用于本地过程通信的标准传输
  • 工具：完全支持所有DeepWriter API操作
  • 日志记录：具有可配置级别的结构化日志记录

可用工具

1.项目列表

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

{
  "api_key": "your_api_key_here"
}

2.获取项目详细信息

检索特定项目的详细信息。

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

3.创建项目

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

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

4.更新项目

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

{
  "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.生成工作

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

{
  "api_key": "your_api_key_here",
  "project_id": "your_project_id_here",
  "is_default": true // Optional, defaults to true
}

6.删除项目

删除项目。

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

发展

项目结构

deepwriter-mcp/
├── src/
│   ├── index.ts              # Main entry point and MCP server setup
│   ├── api/
│   │   └── deepwriterClient.ts  # DeepWriter API client
│   └── tools/                # MCP tool implementations
│       ├── createProject.ts
│       ├── deleteProject.ts
│       ├── generateWork.ts
│       ├── getProjectDetails.ts
│       ├── listProjects.ts
│       └── updateProject.ts
├── build/                    # Compiled JavaScript output
├── test-deepwriter-tools.js  # Tool testing script
├── test-mcp-client.js       # MCP client testing script
└── tsconfig.json            # TypeScript configuration

建筑

npm run build

这将把TypeScript代码编译成JavaScript build 目录。

测试

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

node test-mcp-client.js

或

node test-deepwriter-tools.js

TypeScript配置

该项目使用带有ES模块和Node16模块解析的TypeScript。关键TypeScript设置：

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

故障排除

常见问题

  1. API关键问题:

    • 请确保在中正确设置了DeepWriter API密钥 .env 文件
    • 检查API键是否在工具参数中正确传递
    • 验证API密钥是否具有必要的权限

  2. 连接问题:

    • 确保可以从您的网络访问DeepWriter API
    • 检查是否有任何可能阻止连接的防火墙或代理设置
    • 验证您的网络连接是否稳定

  3. MCP协议问题:

    • 确保您使用的是兼容的MCP客户端
    • 检查stdio传输是否配置正确
    • 验证客户端是否支持协议版本2025-03-26

  4. 参数命名:

    • 服务器同时支持snake_case(project_id)和camelCase(projectId)参数名称
    • 所有参数均区分大小写
    • 必需的参数不能为null或未定义

调试

有关详细日志，请使用DEBUG环境变量运行服务器：

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

您还可以在以下网址查看Claude的桌面日志：

  • macOS： ~/Library/Logs/Claude/mcp*.log
  • 窗户： %APPDATA%\Claude\logs\mcp*.log

贡献

我们欢迎社区的贡献！以下是您可以提供帮助的方式：

提交问题

  1. 错误报告

    • 使用GitHub问题跟踪器
    • 包括重现错误的详细步骤
    • 提供您的环境详细信息（Node.js版本、操作系统等）
    • 包括相关日志和错误消息
    • 使用提供的错误报告模板

  2. 功能请求

    • 使用带有“增强”标签的GitHub问题跟踪器
    • 清楚地描述功能及其用例
    • 解释它如何使项目受益
    • 使用提供的功能请求模板

  3. 安全问题

    • 对于安全漏洞，请不要创建公共问题
    • 电子邮件security@deepwriter.com相反
    • 我们将与您合作解决该漏洞
    • 我们遵循负责任的披露做法

拉取请求

  1. 开始前

    • 检查现有问题和PR，避免重复工作
    • 对于重大更改，请先打开一个问题进行讨论
    • 阅读我们的编码标准和MCP实施指南

  2. 开发过程

    • 分叉存储库
    • 从以下位置创建新分支 main
    • 遵循我们的编码风格和惯例
    • 为新功能添加测试
    • 根据需要更新文档

  3. PR要求

    • 包括对变更的清晰描述
    • 链接相关问题
    • 添加或更新测试
    • 更新文档
    • 遵循提交消息约定
    • 签署贡献者许可协议（CLA）

  4. 代码审查

    • 所有PR都需要至少一次审查
    • 处理审核反馈
    • 保持公关的重点和规模合理
    • 对问题和评论做出回应

开发指南

  1. 代码风格

    • 遵循TypeScript的最佳实践
    • 在我们的配置中使用ESLint
    • 使用Prettier格式化代码
    • 遵循MCP协议规范

  2. 测试

    • 为新功能编写单元测试
    • 保持或提高测试覆盖率
    • 测试MCP协议合规性
    • 使用多个Node.js版本进行测试

  3. 文档

    • 针对面向用户的更改更新README.md
    • 为新代码添加JSDoc注释
    • 更新API文档
    • 包括新功能的示例

  4. 提交消息

    • 遵循常规提交格式
    • 酌情参考问题
    • 保持提交的重点和原子性
    • 使用清晰、描述性的信息

获取帮助

  • 加入我们的Discord社区
  • 检查文档
  • 在GitHub讨论中提问
  • 参加我们每月的投稿人电话会议

安全

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

许可证

麻省理工学院

相关 MCP