Instantly MCP Server

by bcharleson
Verified
# Instantly MCP Server Project ## Project Overview This project creates a Model Context Protocol (MCP) server for the Instantly API v2, allowing Claude to interact with Instantly's email campaign and lead management functionality directly. ## Development Goals 1. Implement key Instantly API v2 endpoints as MCP tools 2. Test functionality locally with Claude Desktop 3. Publish to npm for easy distribution 4. Update documentation for simple installation ## Current Local Testing Configuration During development, we're using a local file configuration in the Claude Desktop: ```json "instantly": { "command": "node", "args": [ "/Users/brandoncharleson/Documents/Developer Projects/instantly-mcp/dist/index.js" ], "env": { "INSTANTLY_API_KEY": "YOUR_API_KEY" } } ``` ## Final Production Configuration After successful testing and npm publication, the goal is to use this configuration: ```json "instantly": { "command": "npx", "args": [ "-y", "@bcharleson/server-instantly" ], "env": { "INSTANTLY_API_KEY": "YOUR_API_KEY" } } ``` ## Implementation Plan 1. ✅ Create basic MCP server structure 2. ✅ Implement initial endpoints (leads, campaigns) 3. ✅ Test locally with claude_desktop_config.json pointing to local build 4. ✅ Publish to npm as @bcharleson/server-instantly 5. Test npm installation with Claude Desktop 6. Add more endpoints incrementally with version updates 7. Create comprehensive documentation ## Endpoints Implemented - instantly_create_lead - instantly_get_lead - instantly_list_leads - instantly_update_lead - instantly_delete_lead - instantly_list_campaigns - instantly_get_campaign ## Future Enhancements - Add email endpoints - Add analytics endpoints - Add account management endpoints - Implement email verification - Add lead list management ## Publishing Process 1. Update version in package.json 2. Build with `npm run build` 3. Publish with `npm publish --access public` 4. Update Claude Desktop configuration to use npm package 5. Test with Claude