PUBLISHING.md•10.3 kB
# MCP Console Automation - Publishing & Registry Guide
This guide will help you publish and list the MCP Console Automation server in various registries and directories to increase visibility.
## 📋 Pre-Publishing Checklist
Before publishing, ensure:
- [x] All tests passing (`npm test`)
- [x] TypeScript compiles (`npm run typecheck`)
- [x] No security vulnerabilities (`npm audit`)
- [x] README.md is comprehensive
- [x] package.json has correct metadata
- [x] Version number is correct in package.json
- [ ] GitHub release created with changelog
## 🚀 Publishing to npm Registry
### 1. Prepare for Publishing
First, ensure you're logged into npm:
```bash
npm login
```
### 2. Update Version (if needed)
```bash
npm version patch # or minor, major
```
### 3. Build the Project
```bash
npm run build
```
### 4. Publish to npm
```bash
npm publish --access public
```
**Note**: Since the package name is `@mcp/console-automation`, you need to ensure you have access to the `@mcp` scope on npm, or change the package name to something like `mcp-console-automation`.
### Alternative: Rename Package
If you don't own the `@mcp` scope, update package.json:
```json
{
"name": "mcp-console-automation",
// ... rest of config
}
```
Then publish:
```bash
npm publish
```
---
## 🏛️ Registry Submissions (10+ Registries)
### 1. 🐳 Docker MCP Registry (BIGGEST - 1M+ Pulls!)
**Website**: https://hub.docker.com/mcp
**Repository**: https://github.com/docker/mcp-registry
**Priority**: **HIGHEST** - Over 100 verified servers, 1M+ pulls
**Steps**:
1. **Containerize your server** - Create a Dockerfile
2. **Submit via GitHub PR** - Create PR at https://github.com/docker/mcp-registry
3. **Follow CONTRIBUTING guide** - Review https://github.com/docker/mcp-registry/blob/main/CONTRIBUTING.md
**Two Submission Options**:
- **Docker-built** (Recommended): Docker builds, signs, and maintains your image with enhanced security
- **Community-built**: You build and maintain the Docker image yourself
**After Approval** (within 24 hours):
- Available on Docker Desktop's MCP Toolkit
- Listed in Docker MCP Catalog
- Published to `mcp/your-server-name` on Docker Hub
**Benefits**:
- Cryptographic signatures & provenance tracking
- Software Bills of Materials (SBOMs)
- Enterprise security features
- Largest MCP ecosystem
---
### 2. 📋 Official MCP Registry (modelcontextprotocol/registry)
**Website**: https://github.com/modelcontextprotocol/registry
**Priority**: **HIGH** - Official community-driven registry (Preview)
**Steps**:
1. **Install MCP Publisher CLI**:
```bash
# Clone and build
git clone https://github.com/modelcontextprotocol/registry.git
cd registry
make publisher
```
2. **Publish your server**:
```bash
./bin/mcp-publisher --help
# Follow OAuth flow for GitHub authentication
```
3. **Submit metadata** in standardized `mcp.json` format
**Requirements**:
- GitHub authentication (OAuth)
- DNS namespace verification (or organization membership)
- Standardized metadata format
---
### 3. 🌟 Glama.ai MCP Directory
**Website**: https://glama.ai/mcp/servers
**Priority**: **HIGH** - Largest collection, ChatGPT-like UI
**Features**:
- Search, compare, and connect to thousands of MCP servers
- Security, compatibility, and ease-of-use rankings
- ChatGPT-like UI interface
- API gateway access
**Steps**:
1. Visit https://glama.ai/mcp
2. Join their Discord for submission info: https://discord.gg/glama
3. Submit via their MCP API or contact form
---
### 4. 📊 PulseMCP (6,150+ Servers)
**Website**: https://www.pulsemcp.com/servers
**Priority**: **MEDIUM** - Daily-updated, comprehensive directory
**Features**:
- Daily automatic updates
- Over 6,150 servers indexed
- Searchable and filterable
**Steps**:
- Appears to auto-discover servers from GitHub
- Ensure your repo has proper MCP tags and description
- Contact via their website for manual submission
---
### 5. 🎯 MCP.so Marketplace
**Website**: https://mcp.so
**Priority**: **MEDIUM** - Community-driven, 16,700+ servers
**Steps**:
1. Visit https://mcp.so
2. Click 'Submit' button in navigation
3. Create GitHub issue with server details:
- Name, description, features
- Repository URL
- Connection information
- Use cases
---
### 6. ⭐ MCPServers.org (Awesome List)
**Website**: https://mcpservers.org
**GitHub**: https://github.com/punkpeye/awesome-mcp-servers
**Steps**:
1. Fork https://github.com/punkpeye/awesome-mcp-servers
2. Add your server to the appropriate category
3. Create Pull Request
---
### 7. 🔧 Smithery.ai
**Website**: https://smithery.ai/
**Steps**:
1. Visit https://smithery.ai/submit
2. Fill out submission form:
- **Name**: MCP Console Automation
- **Description**: Production-ready MCP server for AI-driven console automation and monitoring
- **Repository**: https://github.com/ooples/mcp-console-automation
- **Category**: Automation, Development Tools
- **npm Package**: `mcp-console-automation`
3. Highlight features:
- ✅ 40 comprehensive tools
- ✅ Cross-platform support
- ✅ SSH & remote execution
- ✅ Test automation framework
- ✅ Monitoring & alerts
- ✅ Background job execution
---
### 8. 📚 Awesome MCP Servers (Official GitHub)
**Repository**: https://github.com/modelcontextprotocol/awesome-mcp
**Steps**:
1. Fork the repository
2. Add your entry to README.md:
```markdown
### Development Tools
- [MCP Console Automation](https://github.com/ooples/mcp-console-automation) - Production-ready MCP server for AI-driven console automation and monitoring. 40 tools for session management, SSH, testing, monitoring, and background jobs. Like Playwright for terminal applications.
```
3. Create Pull Request:
- **Title**: "Add MCP Console Automation server"
- **Description**: Brief overview of 40 tools and features
---
### 9. 🌐 MCP Hub
**Website**: https://mcp.run/
**Steps**:
1. Visit https://mcp.run/submit
2. Submit server details:
- **Repository**: https://github.com/ooples/mcp-console-automation
- **npm Package**: `mcp-console-automation`
- **Category**: Development Tools, Automation
- **Tags**: console, terminal, automation, ssh, testing, monitoring, background-jobs
---
### 10. 🔌 Composio MCP Integration
**Website**: https://composio.dev
**Docs**: https://composio.dev/blog/mcp-server-step-by-step-guide-to-building-from-scrtch
**Features**:
- Integration platform for AI agents
- Connect AI with external tools and APIs
- MCP server implementations
**Steps**:
- Check their platform for integration opportunities
- May require partnership or platform listing
---
## 📢 Additional Promotion
### Create GitHub Release
Create a proper GitHub release to make your server more discoverable:
```bash
# Tag the release
git tag -a v1.0.0 -m "Release v1.0.0 - Production-ready MCP Console Automation"
git push origin v1.0.0
```
Then on GitHub:
1. Go to https://github.com/ooples/mcp-console-automation/releases
2. Click "Draft a new release"
3. Select the tag v1.0.0
4. Add release notes highlighting:
- Major features
- Test automation framework
- Cross-platform support
- No native dependencies
- 27/27 tests passing
---
## 📢 Additional Promotion
### Social Media & Communities
1. **Reddit**:
- r/ClaudeAI
- r/LocalLLaMA
- r/MachineLearning
Post format:
```
Title: [Release] MCP Console Automation - Production-ready terminal automation for AI assistants
Body: Explain features, use cases, and link to GitHub
```
2. **Twitter/X**:
- Tweet about the release
- Tag @AnthropicAI, @ClaudeAI
- Use hashtags: #MCP #AI #Automation #LLM
3. **Discord**:
- Anthropic Discord server
- MCP community channels
- Share your server with installation instructions
4. **Dev.to / Medium**:
- Write a tutorial on using MCP Console Automation
- Include real-world examples
- Link to GitHub repo
### Documentation Sites
1. **Model Context Protocol Docs**:
- Check if you can submit to official MCP documentation
- https://modelcontextprotocol.io
2. **Create a Demo Video**:
- Record a 2-3 minute demo showing key features
- Upload to YouTube
- Embed in README
---
## 🏷️ Package.json Metadata
Ensure your package.json has excellent metadata for discoverability:
```json
{
"name": "mcp-console-automation",
"version": "1.0.0",
"description": "Production-ready MCP server for AI-driven console automation and monitoring. Like Playwright for terminal applications.",
"keywords": [
"mcp",
"model-context-protocol",
"console",
"automation",
"terminal",
"ssh",
"testing",
"ai",
"llm",
"claude",
"monitoring",
"playwright",
"selenium",
"test-automation"
],
"author": "ooples",
"license": "MIT",
"repository": {
"type": "git",
"url": "git+https://github.com/ooples/mcp-console-automation.git"
},
"bugs": {
"url": "https://github.com/ooples/mcp-console-automation/issues"
},
"homepage": "https://github.com/ooples/mcp-console-automation#readme"
}
```
---
## ✅ Post-Publishing Checklist
After publishing to registries:
- [ ] npm package published successfully
- [ ] Smithery.ai submission approved
- [ ] Added to Awesome MCP Servers
- [ ] Listed on MCP Hub
- [ ] GitHub release created with changelog
- [ ] Social media announcements posted
- [ ] Documentation updated with installation from npm
- [ ] Monitor GitHub issues for user feedback
---
## 📊 Tracking Success
Monitor these metrics:
- npm downloads: `npm info mcp-console-automation`
- GitHub stars: Watch repository
- Issues/PRs: Engage with community
- Registry rankings: Check Smithery.ai, MCP Hub
---
## 🔄 Version Updates
When releasing new versions:
1. Update CHANGELOG.md
2. Bump version: `npm version patch/minor/major`
3. Build: `npm run build`
4. Test: `npm test`
5. Publish: `npm publish`
6. Create GitHub release
7. Announce in registries (if major update)
---
## 📝 Notes
- **npm scope**: If you can't use `@mcp/console-automation`, use `mcp-console-automation`
- **Response time**: Registry approvals typically take 24-48 hours
- **Updates**: Keep your README and documentation up-to-date
- **Community**: Engage with users, respond to issues promptly