MCP Server Novacv

🚀 MCP Server for NovaCV Resume Service API Access

The MCP server serves as a crucial bridge for accessing the NovaCV resume service API, offering a suite of functions to streamline resume processing and management.

✨ Features

• Generate resume PDF files.
• Retrieve a list of available resume templates.
• Convert resume text into the JSON Resume standard format.
• Analyze resume text content and provide improvement suggestions.

📦 Installation

# System requirement: Node.js (version 12+ recommended)
# Run the following command in the project directory:
npm install mcp-server-novacv

💻 Usage Examples

Basic Usage

Method 1: Run the server directly

npx mcp-server-novacv --version  # Check if the installation was successful
npx mcp-server-novacv --port=3000  # Start the service on a specified port

Method 2: Use the MCP Inspector debugging tool

npx mcp-server-novacv debug  # Start the debugging mode

Advanced Usage

Command-line arguments

• --port: Specify the port on which the server runs. The default is 3000.
• --env: Set the runtime environment (e.g., development, production).

Configuration file

Create or modify the config.json file and add the following content:

{
  "api_key": "your_api_key_here",
  "template_dir": "./templates",
  "default_template": "modern-blue"
}

Available Tools

1. Generate Resume PDF

mcp_novacv_generate_resume_from_text --text="Your resume content" --template="Template name"

2. Get Template List

mcp_novacv_get_templates

3. Convert to JSON Resume Format

mcp_novacv_convert_resume_text --input_file="Path to resume text" --output_file="Output path"

4. Analyze Resume Content

mcp_novacv_analyze_resume_text --file="Path to resume file"

📚 Documentation

Guide to Obtaining an API Key

Before using the MCP server, you need to obtain an API access key for NovaCV:

1. Visit the NovaCV API official website.
2. Register or log in to your account.
3. Find the "API Keys" or "Developer Tools" section in the control panel.
4. Create a new API key and save it securely.
5. Configure the key in the MCP server according to the documentation.

Project Development Process

1. Clone the code repository:

git clone https://github.com/your-repo/mcp-server-novacv.git
cd mcp-server-novacv

2. Install dependencies:

npm install

3. Start in development mode (monitor file changes in real-time):

npm run dev

4. Build the production version:

npm run build

5. Start the built service:

npm start

Debugging and Testing

Use the MCP Inspector tool for debugging:

npm run debug

This will start an interactive console for viewing and analyzing API requests.

Troubleshooting

If you encounter issues, follow these steps to troubleshoot:

1. Confirm that the MCP server is installed correctly: Run npx mcp-server-novacv --version.
2. Check if the API key in the configuration file is correct.
3. Check the console or log files for error messages.

Common Issues

• API Key Issues

  • Ensure that the key is valid and not expired on the NovaCV platform.
  • Check if the key in the configuration file matches the one set on the platform.

• Network Connectivity Issues

  • Confirm that the network communication between the server and the client is normal.

📄 License

This project is licensed under the MIT open-source license, allowing for free use, modification, and distribution.