README Documentation
Project Portfolio Guide MCP Server
A Model Context Protocol server that helps collect and structure project portfolio information through a guided conversation flow.
Features
- Step-by-step project information collection
- GitHub repository integration
- Structured data collection for project portfolios
- RESTful API endpoints
- Docker containerization support
Prerequisites
- Node.js 18.x or higher
- npm or yarn
- Docker (for containerized deployment)
Installation
- Clone the repository:
git clone <repository-url>
cd project-portfolio-guide
- Install dependencies:
npm install
- Build the project:
npm run build
Usage
Local Development
Start the development server:
npm run dev
Production
Start the production server:
npm start
Docker
Build and run with Docker:
docker build -t project-portfolio-guide .
docker run -p 3000:3000 project-portfolio-guide
API Endpoints
POST /message
Send a message to the server and receive the next step in the conversation.
Request body:
{
"content": "user message"
}
Response:
{
"content": "server response",
"metadata": {
"step": 1,
"totalSteps": 15
}
}
GET /health
Check server health status.
Response:
{
"status": "healthy"
}
Deployment to Smithery
- Create a Smithery account at https://smithery.ai
- Install the Smithery CLI:
npm install -g @smithery/cli
- Login to Smithery:
smithery login
- Deploy the server:
smithery deploy
Configuration
The server can be configured using environment variables:
PORT
: Server port number (default: 3000)NODE_ENV
: Node environment (default: production)
License
MIT
Quick Actions
Key Features
Model Context Protocol
Secure Communication
Real-time Updates
Open Source