Metadata-Version: 2.4
Name: iflow-mcp_opentargets-open-targets-platform-mcp
Version: 0.0.1
Summary: Official implementation of Model Context Protocol for Open Targets Platform
Project-URL: Homepage, https://github.com/opentargets/open-targets-platform-mcp
Project-URL: Repository, https://github.com/opentargets/open-targets-platform-mcp
Project-URL: Documentation, https://github.com/opentargets/open-targets-platform-mcp
Author-email: Francesco Carli <carli@ebi.ac.uk>, Paul Ka Po To <kto@ebi.ac.uk>
License-File: LICENSE
Keywords: python
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Healthcare Industry
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Classifier: Topic :: Scientific/Engineering :: Medical Science Apps.
Classifier: Typing :: Typed
Requires-Python: <3.14,>=3.10
Requires-Dist: fastmcp>=2.13.0.2
Requires-Dist: gql[aiohttp]>=4.0.0
Requires-Dist: jq>=1.10.0
Requires-Dist: pydantic-settings>=2.12.0
Requires-Dist: pydantic>=2.12.4
Requires-Dist: typer>=0.20.0
Description-Content-Type: text/markdown

# Open Targets Platform MCP

[![Commit activity](https://img.shields.io/github/commit-activity/m/opentargets/open-targets-platform-mcp)](https://github.com/opentargets/open-targets-platform-mcp/commits)
[![License](https://img.shields.io/github/license/opentargets/open-targets-platform-mcp)](https://github.com/opentargets/open-targets-platform-mcp/blob/main/LICENSE)

> **⚠️ DISCLAIMER: This project is currently experimental and under active development. Features, APIs, and documentation may change without notice ⚠️**

**Model Context Protocol (MCP) server for the [Open Targets Platform API](https://platform.opentargets.org/)**

This package is the official Open Targets Platform MCP server implementation that enables AI assistants to interact with the Open Targets Platform GraphQL API, a comprehensive resource for target-disease associations and drug discovery data.

## Quick Navigation

- [Features](#features)
- [Official MCP Server](#official-mcp-server)
- [Local Deployment](#local-deployment)
- [Advanced Deployment](#advanced-deployment)
- [Available Commands](#available-commands)
- [Server Settings](#server-settings)
- [Available Tools](#available-tools)
- [Strategy](#strategy)
- [Claude Desktop Setup](#claude-desktop-setup)
- [Project Structure](#project-structure)
- [Testing](#testing)
- [Contributing](#contributing)
- [License](#license)

## Features

- 🔍 **GraphQL Schema Access**: Fetch and explore the complete Open Targets Platform GraphQL schema with detailed documentation
- 📊 **Query Execution**: Execute custom GraphQL queries against the Open Targets Platform API
- ⚡ **Batch Query Processing**: Execute the same query multiple times with different parameters efficiently
- 🔎 **Entity Search**: Search for entities across multiple types (targets, diseases, drugs, variants, studies)
- 🛠️ **CLI Tools**: Easy-to-use command-line interface for starting the server
- 🎯 **jq Filtering** (Optional): Server-side JSON processing using [jq](https://jqlang.org/) to reduce token consumption and improve performance. See [jq Filtering](#jq-filtering-optional) for details.

## Official MCP Server

The easiest way to use Open Targets Platform MCP is through the hosted service provided by Open Targets infrastructure at `https://mcp.platform.opentargets.org/mcp`

## Local Deployment

### Via uvx (Quick Start)

The fastest way to get started is using `uvx`, which will automatically download and run the package directly from GitHub.

**Examples:**

```bash
# Start HTTP server bound to localhost:8000 (default)
uvx --from git+https://github.com/opentargets/open-targets-platform-mcp otp-mcp

# Get help
uvx --from git+https://github.com/opentargets/open-targets-platform-mcp otp-mcp --help

# With jq filtering enabled
uvx --from git+https://github.com/opentargets/open-targets-platform-mcp otp-mcp --jq
```

### Docker Deployment

You can run the MCP server using the official Docker image:

```bash
# Pull the latest image
docker pull ghcr.io/opentargets/open-targets-platform-mcp

# Run as a daemon with HTTP transport
docker run -d \
  -p 8000:8000 \
  -e OTP_MCP_HTTP_HOST=0.0.0.0 \
  ghcr.io/opentargets/open-targets-platform-mcp

# Run as a daemon with jq filtering enabled
docker run -d \
  -p 8000:8000 \
  -e OTP_MCP_HTTP_HOST=0.0.0.0 \
  -e OTP_MCP_JQ_ENABLED=true \
  ghcr.io/opentargets/open-targets-platform-mcp
```

### Server Settings
For available CLI arguments and environment variables, see the [Server Settings](#server-settings) table.

## Advanced Deployment

Both advanced deployment options require cloning the repository and setting up the virtual environment first:

```bash
# Clone the repository
git clone https://github.com/opentargets/open-targets-platform-mcp.git
cd open-targets-platform-mcp

# Install dependencies
uv sync --python 3.10
```

### FastMCP CLI

For advanced usage and to utilize all FastMCP options, you can use the FastMCP CLI directly with the server module:

```bash
# Run using FastMCP CLI
uv run fastmcp run ./src/open_targets_platform_mcp/server.py
```

> **Note**: For all FastMCP CLI options, see the [FastMCP documentation](https://gofastmcp.com/patterns/cli#fastmcp-run).  
> **Note**: Use environment variables (see [Server Settings](#server-settings) table) to configure the server when using FastMCP CLI.

### Development Installation (Editable)

For development or to modify the codebase:

```bash
# Run the server
uv run otp-mcp

# Get help
uv run otp-mcp --help
```

## Available Commands

The package provides two command variants:
- `otp-mcp`: Shorter alias (recommended)
- `open-targets-platform-mcp`: Full command name

Both commands are functionally identical.

## Server Settings

Configure the server using environment variables (all prefixed with `OTP_MCP_`). The following table shows all available configuration options:

| Environment Variable | CLI Option | Description | Default |
|---------------------|------------|-------------|---------|
| `OTP_MCP_API_ENDPOINT` | `--api` | Open Targets Platform API endpoint URL | `https://api.platform.opentargets.org/api/v4/graphql` |
| `OTP_MCP_SERVER_NAME` | `--name` | Server name displayed in MCP | `"Model Context Protocol server for Open Targets Platform"` |
| `OTP_MCP_TRANSPORT` | `--transport` | Transport type: `stdio` or `http` | `http` |
| `OTP_MCP_HTTP_HOST` | `--host` | HTTP server host (only used with `http` transport) | `localhost` |
| `OTP_MCP_HTTP_PORT` | `--port` | HTTP server port (only used with `http` transport) | `8000` |
| `OTP_MCP_API_CALL_TIMEOUT` | `--timeout` | Request timeout in seconds for API calls | `30` |
| `OTP_MCP_JQ_ENABLED` | `--jq` | Enable jq filtering support | `false` |
| `OTP_MCP_RATE_LIMITING_ENABLED` | `--rate-limiting` | Enable rate limiting | `false` |

**Examples:**

**Using environment variables:**
```bash
export OTP_MCP_TRANSPORT=stdio
export OTP_MCP_JQ_ENABLED=true
otp-mcp
```

**Using CLI options:**
```bash
otp-mcp --transport stdio --jq
```

**Note:** CLI options take precedence over environment variables when both are provided.

## Available Tools

The MCP server provides the following tools:

1. **`get_open_targets_graphql_schema`**: Fetch the complete GraphQL schema for the Open Targets Platform API, including detailed documentation for all types and fields
2. **`query_open_targets_graphql`**: Execute GraphQL queries to retrieve data about targets, diseases, drugs, and their associations
3. **`batch_query_open_targets_graphql`**: Execute the same GraphQL query multiple times with different variable sets for efficient batch processing
4. **`search_entities`**: Search for entities across multiple types (targets, diseases, drugs, variants, studies) and retrieve their standardized IDs

## Strategy

The MCP server implements a 3-step workflow that guides the LLM to efficiently retrieve data from the Open Targets Platform:

### Step 1: Learn Query Structure from Schema

The LLM calls `get_open_targets_graphql_schema` to understand the GraphQL API structure. The schema includes detailed documentation for all types and fields, enabling the LLM to construct valid queries.

**Key entity types include:**

- **Targets/Genes**: Use ENSEMBL IDs (e.g., `ENSG00000139618` for BRCA2)
- **Diseases**: Use EFO/MONDO IDs (e.g., `MONDO_0007254` for breast cancer)
- **Drugs**: Use ChEMBL IDs (e.g., `CHEMBL1201583` for aspirin)
- **Variants**: Use "chr_pos_ref_alt" format or rsIDs

### Step 2: Resolve Identifiers (if needed)

When a user query contains common names (gene symbols, disease names, drug names), the LLM uses `search_entities` to convert them to standardized IDs required by the API.

### Step 3: Execute Query

The LLM constructs and executes GraphQL queries using:
- Standardized IDs from Step 2
- Query structure from the schema
- **jq filters** (optional, when enabled) to extract only requested fields, minimizing token consumption


**Tool selection:**
- `query_open_targets_graphql` for single queries
- `batch_query_open_targets_graphql` for multiple identical queries with different parameters (reduces latency and tokens)

### jq Filtering (Optional)

The MCP server supports optional server-side JSON processing using jq expressions. This feature is **disabled by default** but can be enabled if you want to reduce token consumption.

#### Enable jq Filtering When:
- You want to reduce token consumption by extracting only specific fields from API responses
- Working with large API responses where only a subset of data is needed
- The calling LLM is proficient at tool calling and can reliably construct jq filters

#### Disable jq Filtering When:
- Simplicity is preferred over optimization
- Working with straightforward queries that don't benefit from filtering
- The LLM should receive complete API responses

#### How jq Filtering Works

When jq filtering is enabled, the query tools expose a `jq_filter` parameter. The jq filter is applied server-side before the response is returned, extracting only the relevant data and discarding unnecessary fields.

**Example:** To extract only the gene symbol and ID from a target query:

```jq
jq_filter: ".data.target | {id, symbol: .approvedSymbol}"
```

This significantly reduces token consumption by returning only the requested fields instead of the full API response.

## Claude Desktop Setup

For detailed instructions on configuring the Open Targets Platform MCP server with Claude Desktop, including both remote hosted service and local installation configurations, see [CLAUDE_DESKTOP.md](CLAUDE_DESKTOP.md).

## Project Structure

```
open-targets-platform-mcp/
├── src/open_targets_platform_mcp/
│   ├── __init__.py          # Package initialization
│   ├── cli.py               # Command-line interface
│   ├── create_server.py     # MCP server creation and setup
│   ├── server.py            # FastMCP server instance
│   ├── settings.py          # Configuration management (pydantic-settings)
│   ├── types.py             # Type definitions (TransportType, etc.)
│   ├── client/              # GraphQL client utilities
│   │   ├── __init__.py
│   │   └── graphql.py       # GraphQL client implementation
│   ├── model/               # Data models
│   │   └── result.py        # Query result models
│   ├── middleware/          # Middleware components
│   │   └── AdaptiveRateLimitingMiddleware.py  # Rate limiting middleware
│   ├── tools/               # MCP tools (organized by feature)
│   │   ├── __init__.py      # Tool exports
│   │   ├── schema/          # Schema fetching tool
│   │   │   └── schema.py
│   │   ├── query/           # Query execution tool
│   │   │   ├── query.py
│   │   │   ├── with_jq_description.txt
│   │   │   └── without_jq_description.txt
│   │   ├── batch_query/     # Batch query tool
│   │   │   ├── batch_query.py
│   │   │   ├── with_jq_description.txt
│   │   │   └── without_jq_description.txt
│   │   └── search_entities/ # Entity search tool
│   │       ├── search_entities.py
│   │       └── description.txt
│   └── static/              # Static assets
│       └── favicon.png
├── test/                    # Test suite
│   ├── conftest.py
│   ├── test_client/
│   │   └── test_graphql.py
│   ├── test_tools/
│   │   ├── test_schema.py
│   │   ├── test_query.py
│   │   └── test_batch_query.py
│   ├── test_config.py
│   └── test_server.py
└── pyproject.toml           # Project configuration and dependencies
```

## Testing

> **Note**: The test suite is currently AI-generated and will be reviewed and refined in the near future.

## Contributing

Contributions are welcome! Please open an issue or submit a pull request on the [GitHub repository](https://github.com/opentargets/open-targets-platform-mcp).

## License

This project is licensed under the terms of the license specified in [LICENSE](LICENSE).
