MCP server for HyperX - connect Claude to your knowledge graph
Project description
HyperX MCP Server
Connect Claude to your HyperX knowledge graph using the Model Context Protocol (MCP).
Installation
pip install hyperx-mcp
Or install from source:
cd hyperx-mcp
pip install -e .
Configuration
Environment Variables
| Variable | Required | Default | Description |
|---|---|---|---|
HYPERX_API_KEY |
Yes | - | Your HyperX API key |
HYPERX_BASE_URL |
No | https://api.hyperxdb.dev |
API base URL |
HYPERX_ACCESS_LEVEL |
No | explore |
Tool access level: read, explore, or full |
Claude Desktop Configuration
Add to your Claude Desktop config file:
macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
Windows: %APPDATA%\Claude\claude_desktop_config.json
{
"mcpServers": {
"hyperx": {
"command": "hyperx-mcp",
"env": {
"HYPERX_API_KEY": "your-api-key-here",
"HYPERX_ACCESS_LEVEL": "explore"
}
}
}
}
Alternative: Using uvx (no install required)
{
"mcpServers": {
"hyperx": {
"command": "uvx",
"args": ["hyperx-mcp"],
"env": {
"HYPERX_API_KEY": "your-api-key-here"
}
}
}
}
Available Tools
Read Level (read)
Basic read-only access for RAG applications.
| Tool | Description |
|---|---|
hyperx_search |
Hybrid search (vector + text) for entities |
hyperx_lookup |
Get entity by ID |
hyperx_paths |
Find paths between entities |
Explore Level (explore)
Extended read access for graph exploration.
| Tool | Description |
|---|---|
hyperx_explorer |
Explore entity neighborhood |
hyperx_explain |
Natural language entity explanation |
hyperx_relationships |
Get entity relationships |
Full Level (full)
Complete access including mutations.
| Tool | Description |
|---|---|
hyperx_entity_crud |
Create, update, delete entities |
hyperx_hyperedge_crud |
Create, update, delete hyperedges |
Quality Signals
All tool responses include quality signals to help Claude self-correct:
{
"success": true,
"data": { ... },
"quality": {
"confidence": 0.85,
"coverage": 0.72,
"diversity": 0.68,
"should_retrieve_more": false,
"suggested_refinements": ["Try searching for 'transformer attention'"]
}
}
- confidence: Overall result quality (0.0-1.0)
- coverage: How well results cover the query
- diversity: Entity type diversity in results
- should_retrieve_more: Hint to expand search
- suggested_refinements: Query improvement suggestions
Example Usage
Once configured, you can ask Claude:
"Search my knowledge graph for information about transformer architectures"
"Find the connection between BERT and GPT in the knowledge graph"
"Explore all entities related to machine learning within 2 hops"
"Create a new concept entity for 'Retrieval Augmented Generation'"
Development
# Install dev dependencies
pip install -e ".[dev]"
# Run tests
pytest
# Run linter
ruff check .
Troubleshooting
"HYPERX_API_KEY environment variable is required"
Make sure you've set the API key in your Claude Desktop config or environment.
Tools not appearing in Claude
- Restart Claude Desktop after config changes
- Check the config file path is correct for your OS
- Verify the
hyperx-mcpcommand is in your PATH
Connection errors
- Check your API key is valid
- Verify network connectivity to
api.hyperxdb.dev - Check if you need to set a custom
HYPERX_BASE_URL
License
MIT
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file hyperx_mcp-0.1.1.tar.gz.
File metadata
- Download URL: hyperx_mcp-0.1.1.tar.gz
- Upload date:
- Size: 5.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c81111737d792338adeb616fe8104bd5ef5e63252d0527de43ce2a58ba9183f8
|
|
| MD5 |
1e8dbbe7905882d8441d67667178d8d5
|
|
| BLAKE2b-256 |
95ae75ba819292fe09fea51c361dfe453e3e228995072bf9580b7ac964989296
|
Provenance
The following attestation bundles were made for hyperx_mcp-0.1.1.tar.gz:
Publisher:
publish-mcp.yml on hyperxdb/hyperx-python
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
hyperx_mcp-0.1.1.tar.gz -
Subject digest:
c81111737d792338adeb616fe8104bd5ef5e63252d0527de43ce2a58ba9183f8 - Sigstore transparency entry: 833847156
- Sigstore integration time:
-
Permalink:
hyperxdb/hyperx-python@36e4c77e32793ca7354cc921758191c79b1cc6cc -
Branch / Tag:
refs/heads/main - Owner: https://github.com/hyperxdb
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-mcp.yml@36e4c77e32793ca7354cc921758191c79b1cc6cc -
Trigger Event:
workflow_dispatch
-
Statement type:
File details
Details for the file hyperx_mcp-0.1.1-py3-none-any.whl.
File metadata
- Download URL: hyperx_mcp-0.1.1-py3-none-any.whl
- Upload date:
- Size: 5.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6668f4135351b8284022ba746413a09d18b4328c256918782cdb4beef0361a0b
|
|
| MD5 |
ec4e074e18aa160e58c96ef1ee50eab3
|
|
| BLAKE2b-256 |
6a9a7d8c785824ea1c9d8178776dcb91199fa77588130d6a2937b84abd64c13d
|
Provenance
The following attestation bundles were made for hyperx_mcp-0.1.1-py3-none-any.whl:
Publisher:
publish-mcp.yml on hyperxdb/hyperx-python
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
hyperx_mcp-0.1.1-py3-none-any.whl -
Subject digest:
6668f4135351b8284022ba746413a09d18b4328c256918782cdb4beef0361a0b - Sigstore transparency entry: 833847157
- Sigstore integration time:
-
Permalink:
hyperxdb/hyperx-python@36e4c77e32793ca7354cc921758191c79b1cc6cc -
Branch / Tag:
refs/heads/main - Owner: https://github.com/hyperxdb
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-mcp.yml@36e4c77e32793ca7354cc921758191c79b1cc6cc -
Trigger Event:
workflow_dispatch
-
Statement type: