Servidor MCP de DeepWriter

Un servidor de Protocolo de Contexto de Modelo (MCP) para interactuar con la API de DeepWriter. Este servidor proporciona herramientas para crear, gestionar y generar contenido para proyectos de DeepWriter mediante la interfaz estandarizada de MCP.

Características

Gestión de proyectos : crear, enumerar, actualizar y eliminar proyectos
Generación de contenido : genere contenido para proyectos utilizando la IA de DeepWriter
Detalles del proyecto : recupera información detallada sobre los proyectos
Integración con MCP : se integra perfectamente con Claude y otros asistentes de IA compatibles con MCP
Características estándar de MCP : Implementa el protocolo MCP versión 2025-03-26
Soporte de transporte : transporte Stdio para la comunicación de procesos locales

Prerrequisitos

Node.js (v17 o superior)
npm (v6 o superior)
Clave API de DeepWriter
Un cliente compatible con MCP (por ejemplo, Claude for Desktop)

Instalación

Clonar el repositorio:
git clone https://github.com/yourusername/deepwriter-mcp.git cd deepwriter-mcp
Instalar dependencias:
npm install
Cree un archivo .env en el directorio raíz con su clave API de DeepWriter:
DEEPWRITER_API_KEY=your_api_key_here
Construir el proyecto:
npm run build

Uso

Iniciando el servidor

Inicie el servidor MCP:

node build/index.js

El servidor escuchará en stdin las solicitudes MCP y responderá en stdout, siguiendo la especificación de transporte stdio de MCP.

Conectarse a Claude para escritorio

Para utilizar el servidor MCP de DeepWriter con Claude for Desktop:

Abra el archivo de configuración de Claude for Desktop:
- macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
- Ventanas: %APPDATA%\Claude\claude_desktop_config.json
Agregue la configuración del servidor:
{ "mcpServers": { "deepwriter": { "command": "node", "args": ["/ABSOLUTE/PATH/TO/deepwriter-mcp/build/index.js"], "env": { "DEEPWRITER_API_KEY": "your_api_key_here" } } } }
Reinicie Claude for Desktop para cargar la nueva configuración.

Compatibilidad con el protocolo MCP

Este servidor implementa el protocolo MCP versión 2025-03-26 con las siguientes capacidades:

Transporte : Transporte de Stdio para la comunicación de procesos locales
Herramientas : Soporte completo para todas las operaciones de la API de DeepWriter
Registro : Registro estructurado con niveles configurables

Herramientas disponibles

1. listaProyectos

Enumera todos los proyectos asociados con su cuenta de DeepWriter.

{
  "api_key": "your_api_key_here"
}

2. obtener detalles del proyecto

Recupera información detallada sobre un proyecto específico.

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

3. crearProyecto

Crea un nuevo proyecto con el título y correo electrónico especificados.

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

4. actualizarProyecto

Actualiza un proyecto existente con los cambios especificados.

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

Genera contenido para un proyecto utilizando la IA de DeepWriter.

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

6. eliminarProyecto

Elimina un proyecto.

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

Desarrollo

Estructura del proyecto

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

Edificio

npm run build

Esto compilará el código TypeScript en JavaScript en el directorio build .

Pruebas

Puede probar el servidor MCP localmente utilizando los scripts de prueba proporcionados:

node test-mcp-client.js

node test-deepwriter-tools.js

Configuración de TypeScript

El proyecto utiliza TypeScript con módulos ES y resolución de módulos Node16. Configuración clave de TypeScript:

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

Solución de problemas

Problemas comunes

Problemas con la clave API :
- Asegúrese de que su clave API de DeepWriter esté configurada correctamente en el archivo .env
- Compruebe que la clave API se esté pasando correctamente en los argumentos de la herramienta
- Verifique que la clave API tenga los permisos necesarios
Problemas de conexión :
- Asegúrese de que la API de DeepWriter sea accesible desde su red
- Compruebe si hay alguna configuración de firewall o proxy que pueda bloquear las conexiones
- Verifique que su conexión de red sea estable
Problemas del protocolo MCP :
- Asegúrese de estar utilizando un cliente MCP compatible
- Compruebe que el transporte stdio esté configurado correctamente
- Verificar que el cliente admita la versión del protocolo 2025-03-26
Nombre de parámetro :
- El servidor admite los nombres de parámetros snake_case ( project_id ) y camelCase ( projectId )
- Todos los parámetros distinguen entre mayúsculas y minúsculas.
- Los parámetros obligatorios no deben ser nulos o indefinidos

Depuración

Para obtener registros detallados, ejecute el servidor con la variable de entorno DEBUG:

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

También puedes consultar los registros de Claude for Desktop en:

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

Contribuyendo

¡Agradecemos las contribuciones de la comunidad! Puedes ayudar de esta manera:

Envío de problemas

Informes de errores
- Utilice el rastreador de problemas de GitHub
- Incluya pasos detallados para reproducir el error.
- Proporcione los detalles de su entorno (versión de Node.js, sistema operativo, etc.)
- Incluir registros y mensajes de error relevantes
- Utilice la plantilla de informe de errores proporcionada
Solicitudes de funciones
- Utilice el rastreador de problemas de GitHub con la etiqueta "mejora"
- Describa claramente la función y su caso de uso.
- Explique cómo beneficia al proyecto.
- Utilice la plantilla de solicitud de función proporcionada
Problemas de seguridad
- Para vulnerabilidades de seguridad, NO cree un problema público.
- En su lugar, envíe un correo electrónico a security@deepwriter.com
- Trabajaremos con usted para abordar la vulnerabilidad.
- Seguimos prácticas de divulgación responsable

Solicitudes de extracción

Antes de empezar
- Verifique los problemas y las relaciones públicas existentes para evitar trabajo duplicado
- Para cambios importantes, primero abra un problema para discutirlo
- Lea nuestros estándares de codificación y pautas de implementación de MCP
Proceso de desarrollo
- Bifurcar el repositorio
- Crear una nueva rama desde main
- Siga nuestro estilo y convenciones de codificación
- Agregar pruebas para nuevas funciones
- Actualice la documentación según sea necesario
Requisitos de relaciones públicas
- Incluya una descripción clara de los cambios
- Problemas relacionados con los enlaces
- Agregar o actualizar pruebas
- Actualizar la documentación
- Seguir las convenciones de mensajes de confirmación
- Firmar el Acuerdo de licencia de colaborador (CLA)
Revisión de código
- Todas las relaciones públicas requieren al menos una revisión
- Comentarios sobre la revisión de la dirección
- Mantenga las relaciones públicas enfocadas y de tamaño razonable
- Responder a preguntas y comentarios

Directrices de desarrollo

Estilo de código
- Siga las mejores prácticas de TypeScript
- Utilice ESLint con nuestra configuración
- Formatear código con Prettier
- Siga las especificaciones del protocolo MCP
Pruebas
- Escribir pruebas unitarias para nuevas funciones
- Mantener o mejorar la cobertura de pruebas
- Prueba de cumplimiento del protocolo MCP
- Prueba con múltiples versiones de Node.js
Documentación
- Actualizar README.md para los cambios que afectan al usuario
- Agregar comentarios JSDoc para el nuevo código
- Actualizar la documentación de la API
- Incluir ejemplos de nuevas funciones
Mensajes de confirmación
- Seguir el formato de confirmaciones convencional
- Cuestiones de referencia cuando corresponda
- Mantenga las confirmaciones enfocadas y atómicas
- Utilice mensajes claros y descriptivos

Obtener ayuda

Únete a nuestra comunidad de Discord
Consulte la documentación
Haz preguntas en las discusiones de GitHub
Asista a nuestras llamadas mensuales para colaboradores

Seguridad

El servidor valida todas las entradas antes de procesarlas
Las claves API nunca se registran ni se exponen en mensajes de error
El transporte stdio proporciona aislamiento del proceso
Todas las llamadas API externas utilizan HTTPS
La validación de entrada previene ataques de inyección

Licencia

Instituto Tecnológico de Massachusetts (MIT)

DeepWriter MCP Server

Integrations