Affinity Designer
Automatize tarefas do Affinity Designer como manipulação de documentos, gerenciamento de camadas e exportações usando IA.
Documentação
Servidor MCP Affinity Designer
Servidor MCP Affinity Designer
📚 Documentação Completa e Exemplos | Documentação Completa e Exemplos
Servidor MCP (Model Context Protocol) para integração com o Affinity Designer. Servidor MCP (Model Context Protocol) para integração com o Affinity Designer.
Visão Geral
Visão Geral
Este servidor MCP permite que assistentes de IA interajam com o Affinity Designer, fornecendo recursos para: Este servidor MCP permite que assistentes de IA interajam com o Affinity Designer, fornecendo recursos para:
- Manipulação de documentos / Manipulação de documentos
- Gerenciamento de camadas / Gerenciamento de camadas
- Operações de exportação / Operações de exportação
- Automação de ferramentas / Automação de ferramentas
Suporte de Plataforma
Suporte de Plataforma
Alvo Principal: Windows Alvo Principal: Windows
A implementação para Windows usa: A implementação para Windows usa:
- Scripts de automação PowerShell / Scripts de automação PowerShell
- COM (Component Object Model) se disponível / COM (Component Object Model) se disponível
- API Win32 para gerenciamento de janelas / API Win32 para gerenciamento de janelas
- Bibliotecas .NET para funcionalidades avançadas / Bibliotecas .NET para funcionalidades avançadas
Alvo Secundário: macOS (Colaboradores Necessários) Alvo Secundário: macOS (Colaboradores Necessários)
Estamos buscando colaboradores com ambiente macOS para ajudar a implementar: Estamos buscando colaboradores com ambiente macOS para ajudar a implementar:
- Integração AppleScript/JavaScript for Automation (JXA) / Integração AppleScript/JavaScript for Automation (JXA)
- Testes e validação no macOS / Testes e validação no macOS
- Desenvolvimento de recursos específicos da plataforma / Desenvolvimento de recursos específicos da plataforma
Se você tem macOS e Affinity Designer, consulte nossa issue de suporte ao macOS para formas de contribuir! Se você tem macOS e Affinity Designer, consulte nossa issue de suporte ao macOS para formas de contribuir!
Pré-requisitos / Pré-requisitos
Requisitos de Instalação do Produto Affinity
Requisitos de Instalação do Produto Affinity
⚠️ IMPORTANTE: Instalação MSI Necessária ⚠️ IMPORTANTE: Instalação MSI Necessária
Para usar este servidor MCP com o Affinity Designer, você deve instalar os produtos Affinity usando o instalador MSI do site oficial. Isso garante que o aplicativo seja instalado em C:\Program Files\ e cria as entradas de registro necessárias para automação.
Para usar este servidor MCP com o Affinity Designer, você deve instalar os produtos Affinity usando o instalador MSI do site oficial. Isso garante que o aplicativo seja instalado em C:\Program Files\ e cria as entradas de registro necessárias para automação.
Configuração de Caminhos de Instalação Personalizados
Configuração de Caminhos de Instalação Personalizados
Se o seu Affinity Designer estiver instalado em um local não padrão, você pode personalizar os caminhos de instalação editando o arquivo affinity-install-paths.json na raiz do projeto:
Se o seu Affinity Designer estiver instalado em um local não padrão, você pode personalizar os caminhos de instalação editando o arquivo affinity-install-paths.json na raiz do projeto:
{
"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:
- Adicione seus caminhos personalizados à seção de plataforma apropriada / Adicione seus caminhos personalizados à seção de plataforma apropriada
- Use caminhos completos para o arquivo executável / Use caminhos completos para o arquivo executável
- No Windows, use barras invertidas duplas (
\\) como separadores de caminho / No Windows, use barras invertidas duplas (\\) como separadores de caminho - O servidor tentará cada caminho em ordem até encontrar uma instalação válida / O servidor tentará cada caminho em ordem até encontrar uma instalação válida
Instalação
Instalação
Método de Clonagem do Repositório GitHub
Método de Clonagem do Repositório 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
Uso
Configure seu cliente MCP para usar este servidor: Configure seu cliente MCP para usar este servidor:
{
"mcpServers": {
"affinity-designer": {
"command": "node",
"args": ["./path/to/mcp-affinity-designer/dist/index.js"]
}
}
}
Desenvolvimento
Desenvolvimento
Configuração
Configuração
# Install dependencies / 依存関係をインストール
npm install
# Build the project / プロジェクトをビルド
npm run build
# Run development server / 開発サーバーを実行
npm run dev
Comandos Disponíveis
Comandos Disponíveis
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型チェックを実行
Testes
Testes
# Test the MCP server manually / MCPサーバーを手動でテスト
node test-server.js
# Or run the server directly / またはサーバーを直接実行
node dist/index.js
Ferramentas Disponíveis
Ferramentas Disponíveis
O servidor MCP atualmente fornece estas ferramentas: O servidor MCP atualmente fornece estas ferramentas:
get_server_info- Obter informações e status do servidor / Obter informações e status do servidorcheck_affinity_designer- Verificar a instalação do Affinity Designer / Verificar a instalação do Affinity Designer
Contribuição
Contribuição
Fluxo de Trabalho de Desenvolvimento
Fluxo de Trabalho de Desenvolvimento
Siga nosso fluxo de trabalho Git e estratégia de branches ao contribuir: Siga nosso fluxo de trabalho Git e estratégia de branches ao contribuir:
- Leia: WORKFLOW.md para diretrizes detalhadas de desenvolvimento
- Leia: WORKFLOW.md para diretrizes detalhadas de desenvolvimento
- Leia: CLAUDE.md para configuração e padrões do projeto
- Leia: CLAUDE.md para configuração e padrões do projeto
Início Rápido para Colaboradores
Início 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"
Qualidade de Código
Qualidade de Código
Todo o código deve atender aos nossos padrões de qualidade: Todo o código deve atender aos nossos padrões de qualidade:
- Revisão Obrigatória: CODE_REVIEW_CHECKLIST.md deve ser seguida
- Revisão Obrigatória: CODE_REVIEW_CHECKLIST.md deve ser seguida
- Auto-revisão necessária: a IA deve revisar e corrigir o código antes de commitar
- Auto-revisão necessária: a IA deve revisar e corrigir o código antes de commitar
Integração Contínua
Integração Contínua
Todos os pull requests executam verificações de qualidade automaticamente: Todos os pull requests executam verificações de qualidade automaticamente:
- Verificação de Tipos TypeScript / Verificação de Tipos TypeScript
- Qualidade de Código ESLint / Qualidade de Código ESLint
- Verificação de Build / Verificação de Build
- Formato de Mensagem de Commit / Formato de Mensagem de Commit
- Verificação de Segurança / Verificação de Segurança
- Análise de Código / Análise de Código
Os PRs devem passar em todas as verificações antes de serem mesclados. Os PRs devem passar em todas as verificações antes de serem mesclados.
Licença
MIT