Сервер DeepWriter MCP

Сервер Model Context Protocol (MCP) для взаимодействия с API DeepWriter. Этот сервер предоставляет инструменты для создания, управления и генерации контента для проектов DeepWriter через стандартизированный интерфейс MCP.

Функции

Управление проектами : создание, перечисление, обновление и удаление проектов.
Генерация контента : генерация контента для проектов с использованием искусственного интеллекта DeepWriter.
Сведения о проекте : получение подробной информации о проектах.
Интеграция с MCP : бесшовная интеграция с Claude и другими совместимыми с MCP помощниками на базе искусственного интеллекта.
Стандартные функции MCP : Реализует версию протокола MCP 2025-03-26
Поддержка транспорта : транспорт Stdio для локальной связи процессов

Related MCP server: Node Omnibus MCP Server

Предпосылки

Node.js (v17 или выше)
npm (v6 или выше)
API-ключ DeepWriter
Клиент, совместимый с MCP (например, Claude for Desktop)

Установка

Клонируйте репозиторий:
git clone https://github.com/yourusername/deepwriter-mcp.git cd deepwriter-mcp
Установите зависимости:
npm install
Создайте файл .env в корневом каталоге с вашим ключом API DeepWriter:
DEEPWRITER_API_KEY=your_api_key_here
Создайте проект:
npm run build

Использование

Запуск сервера

Запустите MCP-сервер:

node build/index.js

Сервер будет прослушивать stdin на предмет запросов MCP и отвечать на stdout, следуя спецификации транспорта MCP stdio.

Подключение к Claude для рабочего стола

Чтобы использовать сервер DeepWriter MCP с Claude for Desktop:

Откройте файл конфигурации Claude for Desktop:
- 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 for Desktop, чтобы загрузить новую конфигурацию.

Поддержка протокола MCP

На этом сервере реализован протокол MCP версии 2025-03-26 со следующими возможностями:

Транспорт : стандартный транспорт для локальной связи процессов
Инструменты : Полная поддержка всех операций API DeepWriter
Ведение журнала : структурированное ведение журнала с настраиваемыми уровнями

Доступные инструменты

1. списокПроекты

Список всех проектов, связанных с вашей учетной записью DeepWriter.

{ "api_key": "your_api_key_here" }

2. получитьProjectDetails

Извлекает подробную информацию о конкретном проекте.

{ "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.

{ "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

Проект использует TypeScript с модулями ES и разрешением модулей Node16. Ключевые настройки TypeScript:

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

Поиск неисправностей

Общие проблемы

Ключевые проблемы API :
- Убедитесь, что ваш ключ API DeepWriter правильно установлен в файле .env
- Проверьте правильность передачи ключа API в аргументах инструмента.
- Убедитесь, что ключ API имеет необходимые разрешения.
Проблемы с подключением :
- Убедитесь, что API DeepWriter доступен из вашей сети.
- Проверьте настройки брандмауэра или прокси-сервера, которые могут блокировать соединения.
- Убедитесь, что ваше сетевое соединение стабильно
Проблемы с протоколом MCP :
- Убедитесь, что вы используете совместимый клиент MCP.
- Проверьте правильность настройки stdio-транспорта.
- Убедитесь, что клиент поддерживает версию протокола 2025-03-26
Именование параметров :
- Сервер поддерживает имена параметров в формате snake_case ( project_id ) и camelCase ( projectId ).
- Все параметры чувствительны к регистру.
- Обязательные параметры не должны быть нулевыми или неопределенными.

Отладка

Для получения подробных журналов запустите сервер с переменной среды DEBUG:

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

Вы также можете проверить журналы Claude for Desktop по адресу:

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

Внося вклад

Мы приветствуем вклад сообщества! Вот как вы можете помочь:

Отправка вопросов

Отчеты об ошибках
- Используйте систему отслеживания ошибок GitHub
- Включите подробные шаги по воспроизведению ошибки.
- Укажите сведения о вашей среде (версия Node.js, ОС и т. д.)
- Включите соответствующие журналы и сообщения об ошибках.
- Используйте предоставленный шаблон отчета об ошибке.
Запросы функций
- Используйте систему отслеживания ошибок GitHub с меткой «улучшение»
- Четко опишите функцию и вариант ее использования
- Объясните, как это принесет пользу проекту
- Используйте предоставленный шаблон запроса функции
Проблемы безопасности
- В случае уязвимостей безопасности, пожалуйста, НЕ создавайте публичную проблему.
- Вместо этого отправьте электронное письмо на адрес security@deepwriter.com
- Мы будем работать с вами над устранением уязвимости.
- Мы следуем ответственной практике раскрытия информации

Запросы на извлечение

Перед началом
- Проверьте существующие проблемы и запросы на исправление ошибок, чтобы избежать дублирования работы.
- Для крупных изменений сначала откройте тему для обсуждения
- Ознакомьтесь с нашими стандартами кодирования и рекомендациями по внедрению MCP
Процесс разработки
- Форк репозитория
- Создать новую ветку из main
- Следуйте нашему стилю кодирования и соглашениям
- Добавить тесты для новых функций
- Обновляйте документацию по мере необходимости.
Требования к связям с общественностью
- Включите четкое описание изменений.
- Проблемы, связанные со ссылками
- Добавить или обновить тесты
- Обновление документации
- Соблюдайте соглашения о сообщениях коммитов
- Подпишите лицензионное соглашение участника (CLA)
Обзор кода
- Все PR требуют как минимум одного обзора
- Адрес отзыва отзыв
- Поддерживайте целенаправленность и разумность PR-кампаний
- Отвечайте на вопросы и комментарии.

Руководство по разработке

Стиль кода
- Следуйте лучшим практикам TypeScript
- Используйте ESLint с нашей конфигурацией
- Форматирование кода с помощью Prettier
- Соблюдайте спецификации протокола MCP
Тестирование
- Напишите модульные тесты для новых функций
- Поддерживать или улучшать тестовое покрытие
- Проверка соответствия протокола MCP
- Тестирование с несколькими версиями Node.js
Документация
- Обновите README.md для изменений, которые заметит пользователь.
- Добавьте комментарии JSDoc для нового кода
- Обновление документации API
- Включите примеры новых функций
Сообщения о фиксации
- Соблюдайте общепринятый формат коммитов
- Справочные материалы по вопросам, где это уместно
- Сохраняйте коммиты сфокусированными и атомарными
- Используйте понятные, описательные сообщения

Получение помощи

Присоединяйтесь к нашему сообществу Discord
Проверьте документацию.
Задавайте вопросы в обсуждениях GitHub
Посещайте наши ежемесячные собрания для участников

Безопасность

Сервер проверяет все входные данные перед обработкой.
Ключи API никогда не регистрируются и не отображаются в сообщениях об ошибках.
Транспорт stdio обеспечивает изоляцию процесса
Все внешние вызовы API используют HTTPS
Проверка входных данных предотвращает атаки с использованием инъекций

Лицензия

Массачусетский технологический институт

DeepWriter MCP Server