Search HPO Terms
search_termsSearch HPO phenotype terms by querying names, synonyms, or definitions to retrieve matching terms with HPO ID, name, and relevance score, plus optional definition and pagination.
Instructions
Full-text search over HPO phenotype term names, synonyms, and definitions (FTS, relevance-ranked). Returns {hpo_id, name, score} -- compact adds a short definition_snippet; standard/full add the complete definition -- plus a pagination block {total, returned, limit, offset, truncated, next_offset}. When truncated, next_commands carries a forward-page step (offset advanced) and a widen step. Obsolete terms are excluded unless include_obsolete=true. Signature: search_terms(query, limit=, offset=, include_obsolete=, response_mode=).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | A phenotype label, synonym, HP id (HP:0000118), or external xref CURIE (UMLS:C0036572, SNOMEDCT_US:193046000, ...). | |
| limit | No | Max hits (default 25). | |
| offset | No | Rows to skip for forward paging (default 0). | |
| include_obsolete | No | Include obsolete terms (default false). | |
| response_mode | No | Verbosity: minimal|compact|standard|full (default compact). | compact |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| success | No | ||
| _meta | No | ||
| error_code | No | ||
| message | No | ||
| retryable | No | ||
| recovery_action | No | ||
| field | No | ||
| allowed_values | No | ||
| hint | No | ||
| candidates | No | ||
| query | No | ||
| include_obsolete | No | ||
| total | No | ||
| returned | No | ||
| limit | No | ||
| offset | No | ||
| next_offset | No | ||
| truncated | No | ||
| results | No | ||
| hpo_version | No |