Affinity Designer

Automatiza tareas de Affinity Designer como manipulación de documentos, gestión de capas y exportaciones usando IA.

Documentación

Servidor MCP de Affinity Designer

Servidor MCP de Affinity Designer

CI PR Checks Documentation Node.js Version TypeScript License: MIT

📚 Documentación completa y ejemplos | 完全なドキュメントと例

Servidor MCP (Model Context Protocol) para la integración con Affinity Designer. Servidor MCP (Model Context Protocol) para la integración con Affinity Designer.

Descripción general

概要

Este servidor MCP permite que los asistentes de IA interactúen con Affinity Designer, proporcionando capacidades para: Este servidor MCP permite que los asistentes de IA interactúen con Affinity Designer, proporcionando capacidades para:

  • Manipulación de documentos / ドキュメント操作
  • Gestión de capas / レイヤー管理
  • Operaciones de exportación / エクスポート操作
  • Automatización de herramientas / ツール自動化

Soporte de plataformas

プラットフォームサポート

Objetivo principal: Windows 主要ターゲット:Windows

La implementación para Windows utiliza: Windows実装では以下を使用します:

  • Scripts de automatización de PowerShell / PowerShell自動化スクリプト
  • COM (Component Object Model) si está disponible / COM(Component Object Model)利用可能な場合
  • API Win32 para la gestión de ventanas / ウィンドウ管理用Win32 API
  • Bibliotecas .NET para funcionalidades avanzadas / 高度な機能用.NETライブラリ

Objetivo secundario: macOS (Se necesitan colaboradores) セカンダリターゲット:macOS(協力者募集中)

Buscamos colaboradores con entorno macOS que ayuden a implementar: macOS環境を持つ協力者を募集して以下の実装をお手伝いいただいています:

  • Integración con AppleScript/JavaScript for Automation (JXA)
  • Pruebas y validación en macOS
  • Desarrollo de funciones específicas de la plataforma

Si tienes macOS y Affinity Designer, consulta nuestro problema de soporte para macOS para ver cómo contribuir. macOSとAffinity Designerをお持ちの方は、協力方法についてmacOSサポートissueをご覧ください。

Requisitos previos / 必要条件

Requisitos de instalación de productos Affinity

Affinity製品インストール要件

⚠️ IMPORTANTE: Se requiere instalación MSI ⚠️ 重要:MSIインストールが必要

Para usar este servidor MCP con Affinity Designer, debes instalar los productos Affinity usando el instalador MSI del sitio web oficial. Esto garantiza que la aplicación se instale en C:\Program Files\ y crea las entradas de registro necesarias para la automatización.

このMCPサーバーをAffinity Designerと使用するには、公式サイトからMSIインストーラーを使用してAffinity製品をインストールする必要があります。これにより、アプリケーションがC:\Program Files\にインストールされ、自動化に必要なレジストリエントリが作成されます。

Configuración de rutas de instalación personalizadas

カスタムインストールパス設定

Si tu Affinity Designer está instalado en una ubicación no estándar, puedes personalizar las rutas de instalación editando el archivo affinity-install-paths.json en la raíz del proyecto:

Affinity Designerが非標準の場所にインストールされている場合、プロジェクトルートのaffinity-install-paths.jsonファイルを編集してインストールパスをカスタマイズできます:

{
  "windows": {
    "affinityInstallPaths": [
      "C:\\Program Files\\Affinity\\Designer 2\\Designer.exe",
      "C:\\Program Files\\Affinity\\Affinity Designer 2\\Affinity Designer 2.exe",
      "C:\\Custom\\Path\\To\\Affinity Designer.exe"
    ]
  },
  "macos": {
    "affinityInstallPaths": [
      "/Applications/Affinity Designer 2.app/Contents/MacOS/Affinity Designer 2",
      "/Applications/Affinity Designer.app/Contents/MacOS/Affinity Designer",
      "/Custom/Path/To/Affinity Designer.app/Contents/MacOS/Affinity Designer"
    ]
  }
}

Notas importantes / 重要な注意事項:

  • Agrega tus rutas personalizadas a la sección de plataforma correspondiente / カスタムパスを適切なプラットフォームセクションに追加してください
  • Usa rutas completas al archivo ejecutable / 実行ファイルへのフルパスを使用してください
  • En Windows, usa dobles barras invertidas (\\) como separadores de ruta / Windowsでは、パス区切り文字に二重バックスラッシュ(\\)を使用してください
  • El servidor probará cada ruta en orden hasta encontrar una instalación válida / サーバーは有効なインストールが見つかるまで各パスを順番に試行します

Instalación

インストール

Método de clonación del repositorio de GitHub / GitHubリポジトリクローン方法

# Clone the repository / リポジトリをクローン
git clone https://github.com/szgk/mcp-affinity-designer.git
cd mcp-affinity-designer

# Install dependencies / 依存関係をインストール
npm install

# Build the project / プロジェクトをビルド
npm run build

Uso

使用方法

Configura tu cliente MCP para usar este servidor: MCPクライアントがこのサーバーを使用するよう設定してください:

{
  "mcpServers": {
    "affinity-designer": {
      "command": "node",
      "args": ["./path/to/mcp-affinity-designer/dist/index.js"]
    }
  }
}

Desarrollo

開発

Configuración / セットアップ

# Install dependencies / 依存関係をインストール
npm install

# Build the project / プロジェクトをビルド
npm run build

# Run development server / 開発サーバーを実行
npm run dev

Comandos disponibles / 利用可能なコマンド

npm run build      # Build TypeScript to JavaScript / TypeScriptをJavaScriptにビルド
npm run dev        # Run development server with auto-reload / 自動リロード付き開発サーバーを実行
npm run lint       # Run ESLint for code quality / コード品質チェック用ESLintを実行
npm run typecheck  # Run TypeScript type checking / TypeScript型チェックを実行

Pruebas / テスト

# Test the MCP server manually / MCPサーバーを手動でテスト
node test-server.js

# Or run the server directly / またはサーバーを直接実行
node dist/index.js

Herramientas disponibles / 利用可能なツール

El servidor MCP actualmente proporciona estas herramientas: MCPサーバーは現在以下のツールを提供します:

  • get_server_info - Obtener información y estado del servidor / サーバー情報とステータスを取得
  • check_affinity_designer - Verificar la instalación de Affinity Designer / Affinity Designerのインストールをチェック

Contribuciones / 貢献

Flujo de trabajo de desarrollo / 開発ワークフロー

Sigue nuestro flujo de trabajo de Git y la estrategia de ramas al contribuir: 貢献する際は、Gitワークフローとブランチ戦略に従ってください:

  • Lee: WORKFLOW.md para obtener pautas de desarrollo detalladas
  • 読む: 詳細な開発ガイドラインは WORKFLOW.md を参照
  • Lee: CLAUDE.md para la configuración y estándares del proyecto
  • 読む: プロジェクト設定と標準については CLAUDE.md を参照

Inicio rápido para colaboradores / 協力者向けクイックスタート

# 1. Create feature branch for issue / issue用featureブランチを作成
git checkout -b feature/issue-N-description

# 2. Write code and perform mandatory self-review / コードを書いて必須セルフレビューを実行
# Follow CODE_REVIEW_CHECKLIST.md before committing
# コミット前にCODE_REVIEW_CHECKLIST.mdに従う

# 3. Make changes with conventional commits / 従来のコミットで変更を作成
git commit -m "feat(scope): description

English description.

日本語説明。

Part of #N"

# 4. Push and create PR / プッシュしてPRを作成
git push -u origin feature/issue-N-description
gh pr create --title "Title" --body "Description"

Calidad del código / コード品質

Todo el código debe cumplir con nuestros estándares de calidad: 全てのコードは品質基準を満たす必要があります:

  • Revisión obligatoria: Se debe seguir CODE_REVIEW_CHECKLIST.md
  • 必須レビュー: CODE_REVIEW_CHECKLIST.md に従う必要があります
  • Autorevisión requerida: La IA debe revisar y corregir el código antes de confirmarlo
  • セルフレビュー必須: AIはコミット前にコードをレビューし修正する必要があります

Integración continua / 継続的インテグレーション

Todas las solicitudes de extracción ejecutan automáticamente controles de calidad: 全てのプルリクエストで品質チェックが自動実行されます:

  • Verificación de tipos de TypeScript / TypeScript型チェック
  • Calidad de código con ESLint / ESLintコード品質
  • Verificación de compilación / ビルド検証
  • Formato de mensajes de confirmación / コミットメッセージ形式
  • Escaneo de seguridad / セキュリティスキャン
  • Análisis de código / コード分析

Las solicitudes de extracción deben superar todos los controles antes de fusionarse. PRは全チェック合格後にマージ可能になります。

Licencia

MIT