Skip to main content

Model Context Protocol server for interacting with the Variant Effect Prediction (VEP) API from Ensembl.

Project description

VEPmcp

VEPmcp is a Model Context Protocol (MCP) server for the Ensembl Variant Effect Predictor (VEP) API. It enables annotation and effect prediction of genetic variants, with full support for batch and single queries, and is designed for seamless integration with MCP-compatible clients (e.g., Claude Desktop, VS Code MCP extension).


Features

  • Annotate variants using Ensembl VEP (HGVS, variant ID, or genomic region)
  • Batch and single variant support
  • Retrieve available species, consequence types, and assembly info
  • Fast, robust, and rate-limited HTTP client
  • JSON-RPC 2.0 over stdio for easy integration with AI tools and editors

Installation

pip install -e .
# or, when available (soon):
pip install VEPmcp

Usage

Command Line

VEPmcp --help
VEPmcp --test-connection      # Test Ensembl API connectivity
VEPmcp --test-mode            # Run server in test mode with sample requests

As an MCP Server

Run the server (for use with MCP clients):

VEPmcp

The server communicates via stdio using JSON-RPC 2.0.


Supported Tools

  • vep_hgvs_single / vep_hgvs_batch: Annotate by HGVS notation
  • vep_id_single / vep_id_batch: Annotate by variant ID (e.g., rsID)
  • vep_region_single / vep_region_batch: Annotate by genomic region
  • get_vep_species: List available species
  • get_consequence_types: List consequence types
  • get_assembly_info: Get assembly info for a species

Example MCP Client Configurations

Claude Desktop

{
  "mcp_servers": {
    "vepmcp": {
      "command": "VEPmcp",
      "args": [],
      "env": {}
    }
  }
}

VS Code MCP Extension

{
  "mcp.servers": {
    "vepmcp": {
      "command": "VEPmcp",
      "args": [],
      "env": {},
      "cwd": "${workspaceFolder}"
    }
  }
}

Example Usage

Prompt your MCP client with:

"Annotate the variant rs56116432 in humans using VEP"

Testing

  • VEPmcp --test-connection — check API connectivity
  • VEPmcp --test-mode — run server in test mode
  • python run_tests.py --mode all --verbose — run all unit/integration tests
  • python run_tests.py --mode ci — run CI pipeline (linting + type checking + unit tests)

Continuous Integration

This project uses GitHub Actions for automated testing on every pull request. The CI pipeline includes:

  • Linting with Ruff
  • Type checking with MyPy
  • Unit and integration tests across Python 3.9-3.13
  • Security scanning
  • Code coverage reporting

Troubleshooting

  • Ensure VEPmcp is installed and in your PATH
  • Check internet connectivity for Ensembl API access
  • Use --verbose for detailed logs

Development

pip install -e .[dev]
python run_tests.py --mode ci  # Run linting, type checking, and unit tests
python run_tests.py --mode all --verbose  # Run all tests including integration

Local Testing Commands

# Linting and formatting
python run_tests.py --mode lint

# Type checking  
python run_tests.py --mode type

# Unit tests only
python run_tests.py --mode unit --verbose

# Integration tests (requires internet)
python run_tests.py --mode integration --verbose

License

MIT License — see LICENSE


Contributing

  1. Fork and branch
  2. Make changes and add tests
  3. Run the test suite
  4. Submit a pull request

Support

For issues and questions, use the GitHub issue tracker.


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vepmcp-0.1.0.tar.gz (15.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

vepmcp-0.1.0-py3-none-any.whl (15.3 kB view details)

Uploaded Python 3

File details

Details for the file vepmcp-0.1.0.tar.gz.

File metadata

  • Download URL: vepmcp-0.1.0.tar.gz
  • Upload date:
  • Size: 15.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for vepmcp-0.1.0.tar.gz
Algorithm Hash digest
SHA256 bab2f1c60c7ed310af1aa31efe64100cedfdaa0abaed0e3bca2940fd8876f825
MD5 ea81aaa75b72f32f810e2ea18a0ca46f
BLAKE2b-256 9a233e0035a50a1718fe31f84e897fb70e7001b247ce087b4ba810baf1cec6af

See more details on using hashes here.

Provenance

The following attestation bundles were made for vepmcp-0.1.0.tar.gz:

Publisher: publish.yml on not-a-feature/VEPmcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file vepmcp-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: vepmcp-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 15.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for vepmcp-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cfdb086760a30127b10d66ef24c6d6357dc86a2e626a76d8512432bc06b72959
MD5 6371f0cb74162986d0bffa182b82f5f8
BLAKE2b-256 fca50297e77471d72ef45722e4eebea6cb23475a798a0095da6e7e7efd70b11d

See more details on using hashes here.

Provenance

The following attestation bundles were made for vepmcp-0.1.0-py3-none-any.whl:

Publisher: publish.yml on not-a-feature/VEPmcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page