MCP Gateway for NovaCV Services

模型上下文协议(MCP)适配器，专门用于对接 NovaCV 简历处理平台的远程应用程序接口(API)。

Core Capabilities

• PDF Generation: Instantly render polished curriculum vitae documents in PDF format.
• Template Retrieval: Query and list the entire catalog of available CV presentation templates.
• Data Structuring: Convert unstructured/plain-text resume input into the canonical JSON Resume specification.
• Content Evaluation: Perform deep textual analysis of resume submissions to yield actionable quality assessments.

Securing Access Credentials

Before initiating any calls via this conduit, an authenticated NovaCV API credential is mandatory:

1. Navigate to the NovaCV API Portal.
2. Authenticate or establish a user account.
3. Locate the section dedicated to API Keys or Developer Credentials.
4. Generate a new secret key and ensure it is securely copied.
5. Configure this key within the MCP service invocation parameters.

Please maintain the confidentiality of your API key; do not expose it in public repositories or logs.

Deployment

bash

Global installation via package manager

npm install -g mcp-server-novacv

Alternatively, invoke directly using npx

npx mcp-server-novacv --api_key=your_secret_key

Operational Quickstart

Method 1: Direct Execution (Recommended)

The most streamlined approach involves using the integrated startup routine:

bash

Execute build and initialize the service endpoint

npm run run

Method 2: Debugging with MCP Inspector

We offer a combined invocation script to simultaneously build the backend and launch the interactive debugging environment:

bash

Build and launch the Inspector interface

npm run debug

Invocation Protocols

Command Line Arguments

bash npx mcp-server-novacv [parameters]

Parameters: --api_key=KEY Specify the NovaCV API authentication token --api_base_url=URL Override the default API endpoint address --timeout=MS Set the maximum waiting period for API responses (milliseconds) --help, -h Display usage instructions --version, -v Show the current package version number

Environment Variable Configuration

Credentials can be supplied via environment variables:

bash NOVACV_API_KEY=your_secret_key mcp-server-novacv

Alternatively, define them in a local .env file:

NOVACV_API_KEY=your_secret_key NOVACV_API_BASE_URL=https://api.nova-cv.com

Note: Obtain your official credentials from NovaCV API Gateway as detailed in the 'Securing Access Credentials' section.

Integration within MCP Client Frameworks

Configuration for Cursor IDE

In your Cursor configuration file, incorporate the service definition:

{ "mcpServers": { "novacv": { "command": "npx", "args": ["mcp-server-novacv"], "env": { "NOVACV_API_KEY": "your_secret_key" } } } }

Configuration for Cherry Studio

Configure the MCP service within Cherry Studio settings:

1. Access Settings (Bottom-left gear icon or Ctrl+,/Cmd+,).
2. Navigate to the MCP or Model Context Protocol configuration area.
3. Add a new service entry with the following mapping:
4. Service Name: novacv
5. Execution Command: npx
6. Arguments: mcp-server-novacv
7. Environment Variables: Add NOVACV_API_KEY and supply your token.

If JSON configuration is preferred, use this structure:

{ "novacv": { "command": "npx", "args": ["mcp-server-novacv"], "env": { "NOVACV_API_KEY": "your_secret_key" } } }

Available Functions

The gateway exposes the following specialized procedural interfaces:

• generate_resume_from_text: Instantly transforms raw CV narrative into a polished PDF, automatically selecting and applying one of the supported presentation layouts without manual intermediate JSON handling.
• get_templates: Returns a comprehensive roster of all deployable CV templates, detailing attributes such as unique identifiers, nomenclature, and preview metadata.
• convert_resume_text: Parses submitted plain-text curriculum vitae data and serializes it strictly according to the internationally recognized JSON Resume schema.
• analyze_resume_text: Conducts an in-depth semantic audit of the input text, providing expert evaluation metrics, completeness scoring, keyword density reports, and targeted optimization advice.

Usage Examples

Querying Template Inventory

Invoke the mcp_novacv_get_templates function within any compatible MCP client environment to retrieve the current template catalog.

Producing a Finalized Document

Execute mcp_novacv_generate_resume_from_text, supplying both the source textual content and the desired template identifier, resulting directly in a professional PDF output.

Textual Content Auditing

Use mcp_novacv_analyze_resume_text against the raw document text to obtain a performance critique.

Text-to-Structured Format Conversion

Employ mcp_novacv_convert_resume_text to map the linear text input into a rigorously structured JSON Resume data object.

Development Lifecycle

bash

Install necessary dependencies

npm install

Run in development mode (enables file watching)

npm run dev

Compile source code assets

npm run build

Production launch sequence (builds and starts the server)

npm run run

Initiate debugging session via Inspector

npm run debug

Troubleshooting Common Issues

Should setup prove problematic, follow these diagnostic steps:

1. Verify core package integrity: npx mcp-server-novacv --version
2. Scrutinize the correctness of the configured API credential.
3. Review the logging output provided by the consuming client application.

Credential Validation Failures

If errors pertain to authentication:

• Confirm the key was sourced correctly from https://api.nova-cv.com.
• Check for key expiration or rate limit transgression.
• Attempt the generation of a completely new API token.
• Ensure no extraneous whitespace or quotation marks surround the key in environment variables or configuration files.

Licensing Information

MIT