An MCP server for automating project customization based on best practices. Analyzes projects and generates customization files for any IDE or tool that supports the Model Context Protocol.
npm install project-customization-mcpAn open-source MCP (Model Context Protocol) server that automates project customization by analyzing your codebase and generating AI-ready configuration files based on industry best practices. Perfect for teams and individual developers who want consistent, framework-aware project guidelines.
Platform-agnostic: Works with any IDE, editor, or AI tool that supports the Model Context Protocol (VS Code, JetBrains, Cursor, Claude, etc.)
This tool automatically:
- π Analyzes your project - Detects frameworks, languages, and project structure
- π Generates guidelines - Creates .github/copilot-instructions.md for consistent development
- βοΈ Updates documentation - Enhances README with best practices
- π‘ Provides recommendations - Suggests improvements for your codebase
- π analyze_project - Scan your project and detect frameworks/languages
- π generate_copilot_instructions - Create customization guidelines for your project
- π update_readme - Generate or enhance README with standards
- π get_customization_recommendations - Get actionable improvement suggestions
- π¦ Project Metadata - Your project type, frameworks, languages
- π Project Structure - Directory organization and files
- π Current Guidelines - Existing customization files
- π README - Your current documentation
- β‘ analyze-and-customize - Full workflow (analyze β generate β update)
- β¨ generate-instructions-only - Create just the instruction file
- π review-and-improve - Review existing customizations
``json`
{
"mcpServers": {
"project-customization": {
"command": "npx",
"args": ["-y", "project-customization-mcp"]
}
}
}
`powershell`
npm install -g project-customization-mcp
Then configure:
`json`
{
"mcpServers": {
"project-customization": {
"command": "project-customization-mcp",
"env": {
"MCP_API_KEY": "YOUR_KEY"
}
}
}
}
Tool execution requires an API key configured via MCP_API_KEY in the MCP server configuration env. If the key is missing, tool calls return an authorization error. Prompts and resources remain available without any key.
Example configuration:
`json`
{
"mcpServers": {
"project-customization": {
"command": "project-customization-mcp",
"env": {
"MCP_API_KEY": "YOUR_KEY"
}
}
}
}
This MCP server does not store memory. Use GitHub Copilot's hosted memory feature for long-lived context, per GitHub's Copilot memory documentation.
- VS Code: Ctrl+Shift+P β "MCP: Open User Configuration"
- Cursor: Settings β MCP Servers
- Other IDEs: Refer to your IDE's MCP documentation
Add one of the configurations above and restart your IDE.
Open your chat and type:
``
Analyze my project and set up customization based on best practices
Or use specific prompts:
``
/analyze-and-customize
/generate-instructions-only
/review-and-improve
Add project context:
- Select "Add Context" β "MCP Resources"
- Choose: Project Metadata, Project Structure, Guidelines, README
The tool creates or updates:
- β
.github/copilot-instructions.md - Project-specific guidelines and standards
- β
README.md - Enhanced with setup and development guidelines
- β
Recommendations - Suggestions for framework-specific improvements
For a React TypeScript project, you get:
`markdownProject Guidelines
- Use functional components with hooks
- Maintain strict TypeScript (no any)
- ESLint + Prettier for formatting
- src/components - React components
- src/pages - Page components
- src/utils - Utilities
- src/hooks - Custom hooks
``
MIT License - See LICENSE file
---
π Made for the Model Context Protocol | Works with any MCP-compatible client