mcp
by: jsonresume
The registry mcp server updates your resume while you code
📌Overview
Purpose: Automate resume updates using AI by analyzing coding projects to enhance the JSON Resume format.
Overview: The JSON Resume MCP Server is a Model Context Protocol (MCP) server designed to empower AI assistants to automatically enrich JSON Resumes by extracting information from a user's codebase. This enables users to easily maintain and update their resumes by simply interacting with their AI assistants.
Key Features:
-
Resume Enhancement: Automatically analyzes the user's codebase and adds relevant project details to the resume, streamlining the update process.
-
GitHub Integration: Seamlessly fetches and updates resumes stored in GitHub Gists, ensuring easy access and management.
-
AI-Powered: Utilizes OpenAI technology to generate professional project descriptions and skills, enhancing the quality of the resume content.
-
TypeScript/Zod Validation: Ensures compliance with the JSON Resume standard, maintaining a reliable format and structure.
-
JSON Resume Ecosystem Compatibility: Fully compatible with the broader JSON Resume registry, allowing for easy integration within existing workflows.
JSON Resume MCP Server
Automate your resume updates with AI by analyzing your coding projects
Overview
The JSON Resume MCP Server is a Model Context Protocol (MCP) server designed to enhance AI assistants. It allows for the updating of your JSON Resume by analyzing your coding projects.
Key Features
- Resume Enhancement: Automatically analyzes your codebase and adds project details to your resume.
- GitHub Integration: Fetches and updates your resume stored in GitHub Gists.
- AI-Powered: Uses OpenAI to generate professional descriptions of your projects and skills.
- TypeScript/Zod Validation: Ensures your resume adheres to the JSON Resume standard.
- Compatibility: Works seamlessly with the JSON Resume registry.
Installation
Prerequisites
- GitHub account with a personal access token (gist scope)
- OpenAI API key
- Node.js 18+
- An IDE with MCP support (Windsurf or Cursor)
Installation Steps
-
Using NPM:
npm install -g @jsonresume/mcp
-
For Windsurf: Add the following to your configuration:
{ "jsonresume": { "command": "npx", "args": ["-y", "@jsonresume/mcp"], "env": { "GITHUB_TOKEN": "your-github-token", "OPENAI_API_KEY": "your-openai-api-key", "GITHUB_USERNAME": "your-github-username" } } }
-
For Cursor: Add to your
~/.cursor/mcp_config.json
:{ "mcpServers": { "jsonresume": { "command": "npx", "args": ["-y", "@jsonresume/mcp"], "env": { "GITHUB_TOKEN": "your-github-token", "OPENAI_API_KEY": "your-openai-api-key", "GITHUB_USERNAME": "your-github-username" } } } }
Usage
Once installed and configured, you can request your AI assistant to:
-
Enhance Your Resume:
"Can you enhance my resume with details from my current project?"
-
Check Resume Status:
"Can you check if I have a JSON Resume?"
-
Analyze Your Codebase:
"What technologies am I using in this project?"
Configuration
The MCP server requires the following environment variables:
Variable | Description |
---|---|
GITHUB_TOKEN | Your GitHub personal access token with gist permissions |
GITHUB_USERNAME | Your GitHub username |
OPENAI_API_KEY | Your OpenAI API key |
Development
To run the server in development mode:
-
Clone the repository:
git clone https://github.com/jsonresume/mcp.git cd mcp
-
Install dependencies:
npm install
-
Run in development mode:
npm run dev
Contributing
Contributions are welcome! Here's how to contribute:
- Fork the repository
- Create a 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
Testing
The MCP server includes test scripts located in the tests/
directory.
Running Tests
Set your environment variables:
export GITHUB_TOKEN=your_github_token
export OPENAI_API_KEY=your_openai_api_key
export GITHUB_USERNAME=your_github_username
Test Commands
-
Check OpenAI API Key:
npx tsx tests/check-openai.ts
-
Mock Resume Enhancement:
npx tsx tests/debug-mock.ts
-
Full Resume Enhancement Test:
npx tsx tests/debug-enhance.ts
-
MCP Protocol Test:
node tests/test-mcp.js
License
This project is licensed under the MIT License.