Skip to content

Latest commit

 

History

History
108 lines (76 loc) · 2.57 KB

File metadata and controls

108 lines (76 loc) · 2.57 KB

Deployment Guide

This document outlines the deployment process for the FlowEngine n8n Workflow Builder MCP Server.

Pre-Deployment Checklist

  • All tests pass
  • Build completes successfully
  • Version bumped in package.json
  • CHANGELOG.md updated
  • README.md comprehensive and up-to-date
  • Smithery configuration files updated
  • No development artifacts in repository
  • Git history clean

Deployment Steps

1. Push to GitHub

git push origin master

This pushes all commits to the GitHub repository.

2. Publish to npm

npm publish

This publishes to the npm registry at: https://www.npmjs.com/package/flowengine-n8n-workflow-builder

Verification:

  • Check package appears on npm
  • Test installation: npm install -g flowengine-n8n-workflow-builder
  • Verify command works: flowengine-n8n --version

3. Submit to Smithery

The package will be automatically indexed by Smithery once published to npm.

Manual submission (if needed):

  1. Visit https://smithery.ai
  2. Submit the package URL
  3. Verify listing appears

Verification:

  • Check package appears on Smithery
  • Test Smithery install: npx @smithery/cli install flowengine-n8n-workflow-builder --client claude

Post-Deployment

Verify Installation Methods

  1. npm (global install):

    npm install -g flowengine-n8n-workflow-builder
    flowengine-n8n
  2. Smithery (Claude Desktop):

    npx @smithery/cli install flowengine-n8n-workflow-builder --client claude
  3. Direct in Claude Desktop:

    • Add to claude_desktop_config.json
    • Restart Claude Desktop
    • Verify MCP server appears

Test in Each Platform

  1. Claude Desktop - Test workflow generation
  2. Claude Code - Test in VS Code
  3. Cursor - Test in Cursor IDE
  4. Cline - Test in VS Code extension
  5. Continue.dev - Test in Continue extension

Monitor

  • npm download stats
  • GitHub issues
  • User feedback
  • Smithery installations

Rollback (if needed)

If issues are discovered:

# Unpublish the version (within 72 hours of publish)
npm unpublish flowengine-n8n-workflow-builder@<version>

# Or deprecate
npm deprecate flowengine-n8n-workflow-builder@<version> "Issue found, use version X.X.X instead"

Version History

See CHANGELOG.md for full version history.

Support Channels