READMEmaster
We couldn't render this README. Read it on GitHub
Nerdic Payload MCP
A tool for generating and managing payload-specific structures.
Features
- Generate payload structures based on templates
- Query existing payload configurations
- Scaffold new payload projects
- Validate payload structures
Installation
- Clone the repository:
git clone https://github.com/your-username/nerdic-payload-mcp.git
cd nerdic-payload-mcp
- Install dependencies:
npm install
- Create a
.envfile based on.env.exampleand fill in your configuration:
cp .env.example .env
Development
To start the development server:
npm run dev
The server will start on http://localhost:3000 by default.
Building for Production
To build the project:
npm run build
To start the production server:
npm start
API Endpoints
MCP Routes
POST /api/mcp/generate- Generate payload structuresGET /api/mcp/query- Query existing configurationsPOST /api/mcp/scaffold- Scaffold new projectsPOST /api/mcp/validate- Validate payload structures
Environment Variables
PORT- Server port (default: 3000)NODE_ENV- Environment (development/production)OPENAI_API_KEY- OpenAI API key for AI featuresCORS_ORIGIN- Allowed CORS origin
Project Structure
NERDIC PAYLOAD MCP/
├── src/
│ ├── api/ # API route definitions
│ │ ├── mcp/ # MCP-specific routes
│ │ └── middleware/ # Express middleware
│ ├── core/ # Core MCP logic
│ └── server.ts # Express app initialization
├── .env # Environment variables
├── package.json # Dependencies and scripts
├── tsconfig.json # TypeScript configuration
└── vercel.json # Vercel deployment config
Contributing
- Fork the repository
- Create your feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add some amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
License
This project is licensed under the MIT License - see the LICENSE file for details.