JSON Resume MCP Server

How to use

You interact with the MCP server through your AI assistant. Start by ensuring the MCP client is installed and configured, then issue requests like: Can you enhance my resume with details from my current project? The assistant will locate your existing resume on GitHub (or create a new one), analyze your current project's codebase, generate professional descriptions of the project and your skills, update the resume, and save the changes back to GitHub. You can also ask the assistant to check whether you have a JSON Resume and to analyze your codebase to identify languages and technologies you are using.

How to install

Prerequisites you need before installing the MCP server are listed below. Install them and then set up the MCP server in your preferred client.

Prerequisites: You need a GitHub account with a personal access token (gist scope), an OpenAI API key, Node.js 18+, and an IDE with MCP support (Windsurf or Cursor).

Install via Smithery (to install for a client like Claude Desktop):

npx -y @smithery/cli install @jsonresume/mcp --client claude

Install via NPM

Install the MCP package globally with npm.

npm install -g @jsonresume/mcp

Configure the MCP server in Windsurf or Cursor

Add the MCP server configuration to your client so it can run the MCP command and pass necessary credentials.

{
  "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"
    }
  }
}

Configure the MCP server in Cursor

Add the MCP server configuration to your Cursor setup so it can be invoked by your assistant.

{
  "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"
      }
    }
  }
}

Configuration

The MCP server requires the following environment variables to run correctly.

GITHUB_TOKEN=your_github_token
GITHUB_USERNAME=your_github_username
OPENAI_API_KEY=your_openai_api_key

Security and usage notes

Keep your GitHub token and OpenAI key secure. Do not expose these credentials in public dashboards or logs. Use scoped tokens and rotate credentials periodically. When enabling automatic resume enhancements, review generated descriptions for accuracy and update as needed.

Troubleshooting

If you experience issues while enhancing your resume, check that your GitHub access token has the gist scope, verify your OpenAI key is active, and confirm Node.js 18+ is installed. Ensure your MCP client configuration includes the correct environment variables and that the MCP server is reachable from your client.

Examples of typical actions

Enhance your resume with details from your current project, check whether you have a resume on GitHub, analyze your codebase for technology signals, and review updated resume content before committing changes.

enhance_resume

Automatically analyzes your codebase to extract projects, skills, and descriptions, then updates the JSON Resume with professional write-ups.

fetch_gists

Fetches and checks the JSON Resume stored in GitHub Gists to locate or update the resume file.

ai_description_generation

Uses AI to generate polished descriptions of projects and technical skills for the resume sections.

validate_resume

Validates that the resume content adheres to the JSON Resume standard using TypeScript/Zod validation.

update_github

Saves the updated resume back to GitHub and provides a link to view the updated resume.