--- name: interpro-database description: > Identify domains, families, and sites in proteins; find all proteins in a family or sharing a domain; explore species distribution for a domain; annotate genomes with protein families and GO terms. InterPro combines 14 databases (e.g., Pfam, CDD) into one searchable resource. InterPro-N significantly expands annotation and sequence coverage with deep learning. Includes domain architecture (IDA) search. --- # InterPro Database Access ## Prerequisites 1. **`uv`**: Read the `uv` skill and follow its Setup instructions to ensure `uv` is installed and on PATH. 2. **User Notification**: If LICENSE_NOTIFICATION.txt does not already exist in this skill directory then (1) prominently notify the user to check the terms at https://www.ebi.ac.uk/interpro/ and https://www.ebi.ac.uk/about/terms-of-use/, then (2) create the file recording the notification text and timestamp. ## Overview InterPro combines signatures from multiple, diverse databases into a single searchable resource, reducing redundancy and helping users interpret their sequence analysis results. By uniting these member databases (e.g., Pfam, CDD, SMART), InterPro capitalises on their individual strengths to produce a powerful diagnostic tool and integrated resource. Use `interpro-database` to: - Identify what domains, families, and sites are found in a particular protein. - Identify all proteins that belong to a protein family or contain a particular domain, even when the names and activities of the proteins are highly variable. - Examine the species in which a particular protein family or domain is found. - Annotate genomes with protein family information and Gene Ontology (GO) terms. This skill provides a robust utility, `interpro_client.py`, to interact with the InterPro API seamlessly. It natively handles rate limiting (HTTP 429), background query sleep tracking (HTTP 408), terminal errors (HTTP 404/410), and lazy pagination. ## Core Rules - **Use the Wrapper**: ALWAYS execute the `scripts/interpro_client.py` helper script to query the database rather than accessing the database directly. The scripts automatically enforce fair use and implement retry logic. - **For exploratory queries**: ALWAYS use the CLI with a strict `--limit`. This allows you to rapidly understand the data schema without polluting your context window or fetching millions of results. - **Output to file**: Use the CLI with --output to output to a file rather than attempting to print it all to the console. Process the output using jq or code. - **For more complex pipelines** import the module natively into your Python scripts to consume the generator directly, preventing the need to deserialize CLI strings in large workflows. - **Notification**: If this skill is used, ensure this is mentioned in the output. Examples: ```bash uv run ./scripts/interpro_client.py fetch protein --source_db reviewed --limit 2 --query_params tax_id=9606 --output exploratory_results.jsonl ``` ```python import sys sys.path.append('scripts') from interpro_client import fetch_interpro_data import itertools # fetch_interpro_data lazily yields results page-by-page results = fetch_interpro_data( endpoint="entry", source_db="pfam", query_params={"page_size": 10} ) for match in itertools.islice(results, 10): print(match["metadata"]["accession"]) ``` ### 4 Ways to Construct Endpoints: The arguments strictly map to the four common API path constructions. **Do not format your own `/` separated strings:** 1. **`/{endpoint}`** (e.g. `/entry`) `uv run ./scripts/interpro_client.py fetch entry --limit 10 --output entries.jsonl` 2. **`/{endpoint}/{sourceDB}`** (e.g. `/entry/pfam`) `uv run ./scripts/interpro_client.py fetch entry --source_db pfam --limit 10 --output pfam_entries.jsonl` 3. **`/{endpoint}/{sourceDB}/{accession}`** (e.g. `/entry/pfam/PF00001`) `uv run ./scripts/interpro_client.py fetch entry --source_db pfam --accession PF00001 --limit 10 --output pf00001_entry.jsonl` 4. **`/{endpoint}/{sourceDB}/{linked_endpoint}/{sourceDB}/{accession}`** (e.g. `/entry/interpro/protein/uniprot/P04637`) `uv run ./scripts/interpro_client.py fetch entry \ --source_db interpro \ --linked_endpoint protein \ --linked_source_db uniprot \ --linked_accession P04637 \ --limit 10 --output p04637_entries.jsonl` ## Valid Source Databases (`--source_db`) Each endpoint only accepts specific `source_db` values. Using an invalid value returns a 404 error. * **`/entry`** (16 values): `interpro`, `pfam`, `cathgene3d`, `ssf`, `panther`, `cdd`, `profile`, `smart`, `ncbifam`, `prosite`, `prints`, `hamap`, `pirsf`, `sfld`, `antifam`. * **`/protein`** (3 values): `uniprot` (all), `reviewed` (SwissProt), `unreviewed` (TrEMBL). * **`/structure`** (1 value): `pdb`. * **`/taxonomy`** (1 value): `uniprot`. * **`/proteome`** (1 value): `uniprot`. * **`/set`** (2 values): `pfam`, `cdd`. ## Quick Reference / Core Endpoints & Parameters **For a complete, exhaustive list of all query parameters, see the [Full API Reference](references/api_reference.md).** The API is fully open and supports 6 core endpoints. You can combine them using the linked parameters described above. Below is a nested list of the specific query parameters available for each endpoint: * **`/entry`** (Domain, family, active site, repeat, or homologous superfamily entries) * `integrated`: Filter by integrated status (e.g., `pfam`). * `type`: Filter by type (e.g., `family`, `domain`, `homologous_superfamily`). * `go_term` / `go_category`: Filter by Gene Ontology. * `ida_search` / `ida_ignore` / `exact` / `ordered`: Filter by domain architecture (see IDA Search section). * `extra_fields`: Request additional data (e.g., `counters` for match coordinates). * `group_by` / `sort_by`: Aggregate or sort results *(valid values depend on context, see [Full API Reference](references/api_reference.md))*. * *Example*: `uv run ./scripts/interpro_client.py count entry --source_db pfam --query_params type=domain --output count.jsonl` * **`/protein`** (Protein records matching entries or domains) * `tax_id`: Filter by taxonomy ID (does not search lineage). * `match_presence`: Filter by proteins having InterPro matches (`true`/`false`). * `is_fragment`: Filter complete vs. fragment sequences. * `group_by`: Aggregate results (e.g., `taxonomy`). * `extra_fields`: Request sequence or match details. * `isoforms` / `residues` / `structureinfo`: Include specific sub-features. * `conservation` / `extra_features`: Append residue conservation flags or Mobidb/coil features *(only valid for `/protein/{source_db}/{accession}`)*. * *Example*: `uv run ./scripts/interpro_client.py fetch protein --source_db uniprot --limit 20 --query_params tax_id=9606 --output human_proteins.jsonl` * **`/structure`** (PDB structures linked to InterPro entries) * `experiment_type`: Filter by experimental method (e.g., `X-RAY DIFFRACTION`). * `resolution`: Filter by resolution limit. * `extra_fields`: Include additional structural metadata. * `group_by`: Aggregate results. * *Example*: `./scripts/interpro_client.py fetch structure --source_db pdb --accession 1ATP --limit 10 --output 1atp_structures.jsonl` * **`/taxonomy`** (Taxonomy distribution nodes) * `key_species`: Filter to limit to key species. * `with_names`: Include scientific names. * `filter_by_entry` / `filter_by_entry_db`: Filter intersection with specific entries. * `extra_fields`: Additional taxonomic metadata. * *Example*: `./scripts/interpro_client.py fetch taxonomy --source_db uniprot --accession 9606 --limit 10 --output human_taxonomy.jsonl` * **`/proteome`** (Complete proteomes linked to InterPro) * `extra_fields`: General query expansion. * *Example*: `uv run ./scripts/interpro_client.py fetch proteome --source_db uniprot --accession UP000005640 --limit 10 --output proteome.jsonl` * **`/set`** (Curated sets of related entries, e.g., Pfam clans) * `extra_fields`: Additional metadata *(only valid for `/set/{sourceDB}`)*. * *Example*: `uv run ./scripts/interpro_client.py fetch set --source_db pfam --accession CL0001 --limit 10 --output pfam_clan.jsonl` ## InterPro Domain Architecture (IDA) Search InterPro provides powerful tools for searching proteins by their domain architecture (the exact combination and order of domains). Because the API does not allow querying proteins directly by multiple domains at once (e.g., "give me proteins with PF00069 AND PF00017"), finding proteins with specific domain combinations requires a two-step process. ### Step 1: Find matching architectures (`ida_search`) The `ida_search` parameter is used on the root `/entry` endpoint to find all Domain Architectures (IDAs) containing the domains you specify. - **Constraints**: - Valid ONLY on the root `/entry` endpoint. - Cannot be combined with non-IDA parameters. - **Modifiers** (Only valid with `ida_search`): - `ida_ignore`: Ignores the given domains in the search (query param). - `ordered`: Ensures domains appear in the exact specified order (flag). - `exact`: Ensures the architecture matches exactly (no additional domains) (flag). **Requires `ordered` flag to be present.** **Example**: Find architectures containing both a kinase domain (PF00069) and an SH2 domain (PF00017), in that exact order: ```bash uv run scripts/interpro_client.py fetch entry --query_params ida_search=PF00069,PF00017 --flags ordered exact --output architectures.jsonl ``` *Note: This returns the architectures and their unique `ida_id`s, not all individual proteins.* ### Step 2: Fetch proteins for those architectures (`ida`) Once you have the `ida_id`s (e.g., `619edbb...`) from Step 1, you can fetch all the actual proteins that share that precise layout by filtering the `/protein` endpoint. **Constraints**: - Valid on `/protein` and `/entry/{sourceDB}/{accession}` endpoints. **Example**: Fetch proteins matching one of the architecture IDs from Step 1: ```bash uv run scripts/interpro_client.py fetch protein --source_db uniprot --query_params ida=619edbb2b445bfa3ad51bd894e3c115b025a5f25 --output matching_proteins.jsonl ``` *(When building pipelines or querying comprehensively, you would loop through all the `ida_id`s from Step 1 and run Step 2 for each one).* ## InterPro Entry Types Each InterPro entry is assigned a type indicating what you can infer when a protein matches the entry: - **Domain**: Distinct functional, structural or sequence units that may exist in a variety of biological contexts. Example: *PH domain* or *classical C2H2 zinc finger*. - **Family**: A group of proteins sharing a common evolutionary origin reflected by related functions, sequence similarities, or primary/secondary/tertiary structures. - **Homologous Superfamily**: Proteins sharing an evolutionary origin reflected by structural similarity but often displaying very low sequence similarity. Usually comprises signatures from the SUPERFAMILY and CATH-Gene3D databases. - **Repeat**: A short sequence that is typically repeated within a protein, often <50 amino acids long. Example: *Leucine Rich Repeats* or *WD40 repeats*. - **Site**: Includes `Active site` (sequence containing conserved residues for catalytic activity) and `Binding site` (sequence containing conserved residues forming a protein interaction site). ## InterPro-N Predictions InterPro-N is a deep-learning-based extension of the standard InterPro database. It utilizes an AI architecture inspired by computer vision to treat protein sequence annotation as a "panoptic segmentation" task, labeling residues and distinguishing between domains. ### When to use InterPro-N Standard InterPro signatures are the "gold standard" and should not be discarded in favor of InterPro-N predictions. Use InterPro-N primarily to fill in gaps or refine results. **In addition to standard InterPro:** - **Analyzing "Dark Matter" (Uncharacterised Proteins)**: Use when a protein returns no hits in standard InterPro. InterPro-N excels at identifying remote homologs. - **Resolving Complex Repeats**: Use for proteins with multiple tandem repeats (e.g., TPR or WD40) where standard HMMs might merge or miss them. - **Predicting Discontinuous Domains**: Use when a domain sequence is interrupted by a completely different inserted sequence. **Instead of standard InterPro (specific scenarios):** - **Precise Boundary Delineation**: When you need more accurate start-and-stop coordinates for a domain than fuzzy standard hits provide. - **Large-Scale Metagenomic Screening**: For initial high-recovery screening of fragmented or highly divergent sequences. ### Fallback Strategy: Checking InterPro-N When you are asked to find annotations for a protein and standard InterPro queries return no results or no annotations, you **MUST** check InterPro-N as a fallback. **Example Scenario:** If a user asks to "List the SSF annotations for protein X" and the standard query returns no hits, you should retry the query with the `interpro_n` flag. This fallback is crucial because InterPro-N can identify remote homologs and domains in "dark matter" proteins that standard methods miss. If found, **ALWAYS** report to the user that these annotations are deep learning predictions from InterPro-N. ### How to Use InterPro-N predictions are accessed by passing the `interpro_n` flag to the `protein` endpoint with `uniprot` as the source database. **Via CLI:** ```bash uv run ./scripts/interpro_client.py fetch protein --source_db uniprot --accession A0A096LNN2 --flags interpro_n --output A0A096LNN2_interpro_n.jsonl ``` **Via Python Pipeline:** ```python results = fetch_interpro_data( endpoint="protein", source_db="uniprot", accession="A0A096LNN2", flags=["interpro_n"]) ``` ## Strict Lookup Rules 1. **Always Use UniProt Accessions, NEVER Gene Names:** When looking up proteins in InterPro, you MUST use their UniProt Accessions (e.g. `P04637`). InterPro does not natively support or reliably map gene names (e.g. `TP53`). If the user provides a gene name, you must use a database like Ensembl or UniProt first to resolve it to an accession. 2. **NEVER Iterate to Count:** When asked for an aggregate count (e.g., "How many domains are there?"), you MUST read the `count` field from the initial API JSON response using the `get_interpro_count()` helper. NEVER iterate over the `fetch_interpro_data` generator to tally elements. Iterating over an endpoint with 50,000+ entries just to count them silently hangs the agent and abuses the API. Every time. No exceptions. ✅ **Correct**: **Via CLI:** ```bash uv run ./scripts/interpro_client.py count entry --source_db interpro --query_params type=domain --output count.json ``` **Via Python Pipeline:** ```python from interpro_client import get_interpro_count cnt = get_interpro_count( endpoint="entry", source_db="interpro", query_params={"type": "domain"}, ) ``` ❌ **Wrong** (Iterating over fetch): ```bash # NEVER DO THIS: uv run ./scripts/interpro_client.py fetch entry --source_db interpro --query_params type=domain --output output.jsonl && wc -l output.jsonl ``` ## Quick examples **For detailed examples of the invocations and JSON output schemas returned by various endpoints, see the [Example Responses Reference](references/example_responses.tsv).** This TSV contains command-line calls, Python equivalents, and the corresponding JSON payload structures. ### 1. Determining all protein domains ```bash # Fetches InterPro Entries within UniProt protein P04637 # URL equivalent: /entry/interpro/protein/uniprot/P04637 uv run ./scripts/interpro_client.py fetch entry --source_db interpro --linked_endpoint protein --linked_source_db uniprot --linked_accession P04637 --output p04637_domains.jsonl ``` ### 2. Fetching all PDB structures for an Entry ```bash # URL equivalent: /structure/pdb/entry/interpro/IPR011615 # Only fetch the first 5 structures uv run ./scripts/interpro_client.py fetch structure --source_db pdb --linked_endpoint entry --linked_source_db interpro --linked_accession IPR011615 --output ipr011615_structures.jsonl ``` --- Source attribution: mkurman Original project: https://github.com/mkurman/zorai/blob/d06ee7597049567dab92db22d41b2764cf89094a/skills/scientific-skills-gdm/interpro_database/SKILL.md License: Apache-2.0 License information: https://www.apache.org/licenses/LICENSE-2.0 Original upstream instructions; downloaded from Mega AI Hub. ## Upstream license notice Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. # Mega AI Hub resource metadata Creator / publisher: mkurman Original project: https://github.com/mkurman/zorai/blob/d06ee7597049567dab92db22d41b2764cf89094a/skills/scientific-skills-gdm/interpro_database/SKILL.md Attribution basis: Source repository record Fields of work: Data & Analytics, Education & Research, Product Management Roles: Business Intelligence Analyst, Data Scientist, Market Research Analyst, Product Manager, Researcher Specialties: API Tools: Interpro Api Country applicability: Country not specified Classification basis: Source catalog labels Instruction SHA-256: 8368e6a5c630572d68d0c1078bb0ca13ea5ee04ba8f6b5d4483191d9cafce30c