--- name: embl-ebi-ols description: > Query and search the EMBL-EBI Ontology Lookup Service (OLS) for biomedical ontology terms, definitions, and hierarchies across 250+ ontologies (e.g., GO, DOID, HP). Use when the user asks to search for terms, retrieve details, navigate hierarchies (parents, children, ancestors), look up properties and individuals, get autocomplete suggestions, or access ontology metadata and statistics. --- # EMBL-EBI Ontology Lookup Service (OLS) ## 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/ols4/api-docs, then (2) create the file recording the notification text and timestamp. ## Core Rules - [!IMPORTANT] **Use the Utility Scripts**: You MUST ALWAYS use the provided utility script under `scripts/` for all API interactions, including checking status. NEVER use `curl` or custom Python requests to query API directly. - **Rate Limiting & Resilience**: You MUST respect EBI's Terms of Use with a maximum 5 requests per second. The provided utility scripts automatically enforce this. - **Notification**: If this skill is used, ensure this is mentioned in the output. ## When to Use — Quick Recipes Use this skill whenever a user query matches one of these patterns: - **Definition** of a disease, phenotype, or term → `get_term.py --obo_id --summary` - **Subtypes** or **children** of a term → `get_term.py --obo_id --relations children` - **Parent** of a term → `get_term.py --obo_id --relations parents` - **Ancestors** / disease **categories** / **classified under** → `get_term.py --obo_id --relations ancestors` - **Root terms** of an ontology → `get_term.py --ontology --roots` - **Hierarchical** parents (is-a + part-of) → `get_term.py --obo_id --relations hierarchicalParents` - **Structures part of** / hierarchical children → `get_term.py --obo_id --relations hierarchicalChildren` - **Compare** direct vs hierarchical parents → `get_term.py --obo_id --relations parents,hierarchicalParents` - Search for a term (e.g., "apoptosis" in GO) → `search_ols.py --query "..." --ontology ` - Find a **GO term** matching a function → `search_ols.py --query "..." --ontology go --exact` - Search in **MONDO**, **CHEBI**, **CL**, **UBERON** → `search_ols.py --query "..." --ontology --defining` - **Paginate** search results / next page → `search_ols.py --query "..." --rows N --start ` - Autocomplete a partial name → `suggest_ols.py --query "..."` - Ontology metadata (e.g., EFO info) → `get_ontology.py --id ` - OLS index statistics → `get_stats.py` > **Multi-step queries** (e.g., "What is the parent of myocardial infarction?"): > When the user names a term but you don't know its OBO ID, complete in > **exactly 2 steps** — do NOT search across multiple ontologies: > > 1. **Search** in the single most appropriate ontology: `search_ols.py --query > "myocardial infarction" --ontology doid --exact --rows 1 --output > /tmp/step1.json` > 2. **Get relations** using the OBO ID from step 1: `get_term.py --obo_id > DOID:5844 --relations parents --output /tmp/step2.json` > > **Ontology selection rule**: ALWAYS use `doid` for common human diseases > (e.g., diabetes, cancer), `hp` for phenotypes, `go` for gene functions, > `chebi` for chemicals, `uberon` for anatomy, `cl` for cell types. Use `mondo` > ONLY when cross-species context is explicitly mentioned or needed. ## Utility Scripts **1. Search Terms Across Ontologies** Search for ontology terms by keyword and return clean JSON. ```bash uv run scripts/search_ols.py --query "diabetes" \ --rows 5 --output /tmp/ols_search_results.json 2>/dev/null ``` > **Important**: `--output` is required for all scripts. Results are always > written to the specified file. For larger output, you can limit `--rows` > (e.g., 5-10) or paginate using `--start`. *Returned Fields:* JSON results include `iri`, `label`, `description`, `ontology_name`, `ontology_prefix`, `obo_id`, `short_form`, `type`, `is_defining_ontology`, and `exact_synonyms`. *Pagination:* Output includes a `pagination` block with `start`, `rows`, and `has_more` so you can decide whether to fetch more results. *Options:* - `--query`: Search string (required). Searches labels, synonyms, descriptions, and identifiers. - `--ontology`: Filter by ontology ID (e.g., `go`, `doid`, `efo`, `hp`). **Recommended** when you know which ontology to search — avoids noise from 250+ ontologies. - `--type`: Filter by entity type: `class`, `property`, `individual`, or `ontology`. - `--exact`: Flag for exact label match only. **Use this for entity resolution** when mapping a user's string to a specific ontology term ID. - `--defining`: Only return terms from their defining (authoritative) ontology. E.g., `GO:0005634` only from GO, not cross-referenced copies. - `--obsolete`: Flag to include obsolete terms in results. - `--local`: Only return terms in their defining ontology. - `--childrenOf`: Restrict to children of given term IRI(s), comma-separated. - `--allChildrenOf`: Restrict to all children including transitive relations (part of, develops from), comma-separated IRIs. - `--queryFields`: Comma-separated fields to search in (e.g., `label,synonym,description`). - `--fieldList`: Comma-separated fields to return. - `--groupField`: Group results by unique IRI. - `--isLeaf`: Only return leaf terms (no children). - `--rows`: Number of results to return (default 10). - `--start`: Pagination offset (default 0). - `--output`: File path to save results (**required**). **2. Autocomplete / Suggest** Get autocomplete suggestions for partial term names. ```bash uv run scripts/suggest_ols.py --query "diabet" --rows 5 \ --output /tmp/ols_suggest.json 2>/dev/null ``` *Options:* - `--query`: Partial term to autocomplete (required). - `--ontology`: Filter by ontology ID(s), comma-separated. - `--rows`: Number of suggestions (default 10). - `--start`: Pagination offset (default 0). - `--output`: File path to save results (default: stdout). **3. Get Term Details** Retrieve full details for a specific ontology term by its OBO ID or IRI. ```bash uv run scripts/get_term.py --obo_id "GO:0005634" \ --output /tmp/ols_term.json 2>/dev/null ``` *Returned Fields:* JSON includes `iri`, `label`, `description`, `obo_id`, `synonyms`, `ontology_name`, `is_obsolete`, `is_defining_ontology`, `has_children`, `is_root`, `annotation`, `in_subset`, and any requested relations. *Summary Mode:* Use `--summary` to get a clean, human-readable block on stdout (Label, OBO ID, Ontology, Definition, Synonyms). The full JSON is always saved to the `--output` file. ```bash uv run scripts/get_term.py --obo_id "GO:0005634" --summary \ --output /tmp/nucleus_full.json ``` *Options:* - `--obo_id`: OBO-style identifier (e.g., `GO:0005634`, `DOID:9351`). Mutually exclusive with `--iri`. Auto-converts to IRI with double encoding. - `--iri`: Full IRI of the term. Mutually exclusive with `--obo_id`. - `--ontology`: Ontology ID (auto-derived from `--obo_id` if not provided). - `--relations`: Comma-separated list of relations to fetch. - **Direct (is-a only):** `parents`, `children`, `ancestors`, `descendants` - **Hierarchical (is-a + transitive like "part of", "develops from"):** `hierarchicalParents`, `hierarchicalChildren`, `hierarchicalAncestors`, `hierarchicalDescendants` - **Graph:** `graph` — full graph JSON for a term > **Note**: Use hierarchical variants for anatomical/developmental > ontologies (UBERON, CL) where transitive relations like "part of" and > "develops from" are critical for navigating the hierarchy. - `--roots`: List root terms of the ontology (requires `--ontology`). - `--preferred_roots`: List preferred root terms (requires `--ontology`). - `--summary`: Human-readable summary on stdout, full JSON to `--output`. - `--output`: File path to save results (default: stdout). **4. Get Property Details** Retrieve details for an ontology property (relation type) with hierarchy. ```bash uv run scripts/get_property.py --obo_id "BFO:0000051" --ontology go \ --output /tmp/ols_property.json 2>/dev/null ``` *Options:* - `--obo_id`: OBO-style ID of the property. Mutually exclusive with `--iri`. - `--iri`: Full IRI of the property. Mutually exclusive with `--obo_id`. - `--ontology`: Ontology ID (required with `--iri`). - `--relations`: Comma-separated: `parents`, `children`, `ancestors`, `descendants`. - `--roots`: List root properties of the ontology (requires `--ontology`). - `--output`: File path to save results (default: stdout). **5. Get Individual Details** Retrieve details for an ontology individual (instance). ```bash uv run scripts/get_individual.py --obo_id "IAO:0000103" --ontology iao --types \ --output /tmp/ols_individual.json 2>/dev/null ``` *Options:* - `--obo_id`: OBO-style ID. Mutually exclusive with `--iri`. - `--iri`: Full IRI. Mutually exclusive with `--obo_id`. - `--ontology`: Ontology ID (required with `--iri`). - `--types`: Fetch the direct types (classes) of this individual. - `--alltypes`: Fetch all types including ancestor classes. - `--output`: File path to save results (default: stdout). **6. Get Ontology Information** List available ontologies or retrieve details for a specific one. ```bash uv run scripts/get_ontology.py --id go \ --output /tmp/ols_ontology.json 2>/dev/null ``` *Options:* - `--id`: Specific ontology ID (e.g., `go`, `efo`, `doid`). If omitted, lists all ontologies. - `--page`: Page number for pagination (default 0). - `--size`: Number of ontologies per page (default 20). - `--output`: File path to save results (default: stdout). **7. Get OLS Statistics** Retrieve index statistics (total ontologies, classes, properties, individuals). ```bash uv run scripts/get_stats.py --output /tmp/ols_stats.json 2>/dev/null ``` *Options:* - `--output`: File path to save results (default: stdout). ## Reference - **API Reference**: See [references/api_reference.md](references/api_reference.md) for common ontology IDs, OBO ID format, and key API endpoints. ## Workflow 1. Use `suggest_ols.py` for autocomplete when you have a partial term name. 2. Search for terms using `search_ols.py`. Use `--defining` to prioritize authoritative definitions. Use `--exact` for entity resolution. 3. If full details are needed, use `get_term.py` with the OBO ID or IRI. Use `--summary` for a concise view. 4. To explore a term's hierarchy, use `get_term.py --relations parents,children` for is-a only, or `--relations hierarchicalParents,hierarchicalChildren` for "part of" etc. 5. To explore from the top down, use `get_term.py --ontology go --roots`. 6. For properties or individuals, use `get_property.py` or `get_individual.py`. 7. To discover available ontologies, use `get_ontology.py`. 8. To check OLS index status, use `get_stats.py`. --- Source attribution: mkurman Original project: https://github.com/mkurman/zorai/blob/d06ee7597049567dab92db22d41b2764cf89094a/skills/scientific-skills-gdm/embl_ebi_ols/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/embl_ebi_ols/SKILL.md Attribution basis: Source repository record Fields of work: Data & Analytics, Education & Research Roles: Business Intelligence Analyst, Data Scientist, Researcher Specialties: API Tools: Uv Country applicability: Country not specified Classification basis: Source catalog labels Instruction SHA-256: 24669c1be13259c5e73362e889d953903df5942ad47a1abe2b6926b0bf34eb03