Skip to main content

MCP server for interacting with the Explorium API.

Project description

Explorium API MCP Server

This MCP server is used to interact with the Explorium API.

Note: this is the README for developing the MCP server. For usage instructions, see the README-pypi.md.

Setup

Clone the repository:

git clone https://github.com/explorium-ai/mcp-explorium.git
cd mcp-explorium

Install uv and activate the virtual environment:

pip install uv
uv sync --group dev

Running Locally

When developing locally, use local_dev_server.py to expose the MCP server to local clients.

You can test it with the MCP Inspector:

mcp dev local_dev_server.py

Create an .env file in the root of the repository with an EXPLORIUM_API_KEY environment variable if it's not already configured.

Usage with Claude Desktop

Follow the official guide to install Claude Desktop and set it up to use MCP servers:

https://modelcontextprotocol.io/quickstart/user

Then, add this entry to your claude_desktop_config.json file:

{
  "mcpServers": {
    "Explorium": {
      "command": "<UV_INSTALL_PATH>",
      "args": [
        "run",
        "--directory",
        "<REPOSITORY_PATH>",
        "mcp",
        "run",
        "local_dev_server.py"
      ],
      "env": {
        "EXPLORIUM_API_KEY": "<YOUR_API_KEY>"
      }
    }
  }
}

Be sure to replace all the <PLACEHOLDERS> with the actual values.

Run which uv to get your uv install path.

Usage with Cursor

Cursor has built-in support for MCP servers.

To configure it to use the Explorium MCP server, go to Cursor > Settings > Cursor Settings > MCP and add an "Explorium" entry with this command:

uv run --directory repo_path mcp run local_dev_server.py

Make sure to replace repo_path with the actual path to the repository.

You may turn on "Yolo mode" in Cursor settings to use tools without confirming under Cursor > Settings > Cursor Settings > Features > Chat > Enable Yolo mode.

Note: local usage will not work if dev dependencies are not installed, or if the virtual environment is not activated.

Building and Deploying

To build the MCP server, bump the version in pyproject.toml, then run:

uv build

This will create a dist directory with the built package.

You may then deploy the package to PyPI using the following command:

twine upload dist/*

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

explorium_mcp_server-0.2.6.tar.gz (61.1 kB view details)

Uploaded Source

Built Distribution

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

explorium_mcp_server-0.2.6-py3-none-any.whl (20.3 kB view details)

Uploaded Python 3

File details

Details for the file explorium_mcp_server-0.2.6.tar.gz.

File metadata

  • Download URL: explorium_mcp_server-0.2.6.tar.gz
  • Upload date:
  • Size: 61.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.9

File hashes

Hashes for explorium_mcp_server-0.2.6.tar.gz
Algorithm Hash digest
SHA256 5d01497e0828dfc68f9a16a35c0e8bce6c5b7e6cfdffb7ee6468c3ca05638e76
MD5 4e6b4d602cb966f912f631332fec59ec
BLAKE2b-256 cf677622f69149a0ecf423dc6d1bf4173a34b429290c13924ebfdb9756bf8824

See more details on using hashes here.

File details

Details for the file explorium_mcp_server-0.2.6-py3-none-any.whl.

File metadata

File hashes

Hashes for explorium_mcp_server-0.2.6-py3-none-any.whl
Algorithm Hash digest
SHA256 6fb9a90b0985e12c681e58f5a173eebf886d3b854ef3fd795ace7475696770c3
MD5 ef04adb6880fe51adf340f3d9844ceb7
BLAKE2b-256 43c4f7a046f791af2488e9a7b77520134a22b3c11fac11bc2cff5a204c2b6899

See more details on using hashes here.

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