This is the official documentation website for MCP Server Generator, a modern CLI tool for generating and extending production-ready Model Context Protocol (MCP) servers.
π Live Documentation: mcp-server-generator.com
This documentation site provides comprehensive guides, examples, and API references for:
- π Project Generation - Creating new MCP servers with comprehensive features
- β Component Extension - Adding tools, resources, prompts, services, transports, and utilities
- π Developer Guides - Installation, CLI commands, and best practices
- π§ API Reference - Complete technical documentation
- π‘ Examples - Real-world use cases and implementation patterns
This website is built using Docusaurus, a modern static website generator that provides:
- π± Responsive Design - Works on all devices
- π Dark/Light Mode - Theme switching support
- π Built-in Search - Fast content discovery
- π Versioning - Multiple documentation versions
- π Internationalization - Multi-language support
- Node.js 18+ - Download from nodejs.org
- npm or yarn - Package manager
# Clone the repository git clone https://github.com/LinuxDevil/Create-MCP.git cd Create-MCP/docs # Install dependencies npm install # or yarn install
# Start development server npm start # or yarn start
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
Local URL: http://localhost:3000
# Generate static content npm run build # or yarn build
This command generates static content into the build
directory and can be served using any static contents hosting service.
# Using SSH USE_SSH=true npm run deploy # or USE_SSH=true yarn deploy # Using HTTPS GIT_USER=<Your GitHub username> npm run deploy # or GIT_USER=<Your GitHub username> yarn deploy
The build
directory can be deployed to:
- Vercel -
vercel --prod
- Netlify - Drag and drop
build
folder - AWS S3 - Upload
build
contents - Cloudflare Pages - Connect GitHub repository
docs/ βββ intro.md # Getting started βββ installation.md # Installation guide βββ cli-commands.md # CLI reference βββ examples.md # Usage examples βββ components/ # Component guides β βββ overview.md # Component overview βββ api/ # API reference β βββ overview.md # API documentation blog/ # Blog posts βββ authors.yml # Author information βββ 2025-09-25-component-extension-release.md
We welcome contributions to improve the documentation:
- Fork the repository
- Create a feature branch:
git checkout -b docs/improve-examples
- Edit markdown files in the
docs/
directory - Test locally:
npm start
- Commit changes:
git commit -m 'Improve examples documentation'
- Push to branch:
git push origin docs/improve-examples
- Open a Pull Request
- Create new
.md
file in appropriate directory - Update
sidebars.ts
to include the new page - Add internal links from related pages
- Test navigation and links locally
- Create new file:
blog/YYYY-MM-DD-post-title.md
- Add frontmatter with title, authors, tags
- Write content with code examples
- Update
authors.yml
if adding new author
- Use clear, concise language
- Include code examples for technical concepts
- Add emojis for visual appeal (sparingly)
- Structure content with proper headings
- Link to related documentation
- π Homepage: mcp-server-generator.com
- π¦ NPM Package: mcp-server-generator
- π GitHub Repository: LinuxDevil/Create-MCP
- π Issues: GitHub Issues
- π¬ Discussions: GitHub Discussions
- π MCP Protocol: modelcontextprotocol.io
This documentation is part of the MCP Server Generator project and is licensed under the MIT License. See the LICENSE file for details.