> For the complete documentation index, see [llms.txt](https://docs.biobox.io/guide/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.biobox.io/guide/how-to/ask-biobox-with-claude/tools/get-ql-instructions.md).

# get\_ql\_instructions — Get the org's query-building instructions

Get the org's query-building instructions

Get the org's query-building instructions

## What it does

Fetch the organization's DB-authored query-building guidance (concept / relationship / property / entity-resolution / orchestrator / one-shot instructions) so a generated query follows the org's own conventions.

**When to use:** before assembling a query, to pick up org-specific rules on concepts/relationships/properties; when you need the org's entity-resolution or one-shot query-generation guidance.

**When NOT to use:** you want reusable query templates / intent→cypher hints — use list\_query\_templates; you want the org's evidence-line definitions — use list\_evidence\_catalog.

**Parameters:** none.

**Returns:** An object with the org's instruction fields (any may be null if unset): generalInstructions, conceptMessage, relationshipMessage, propertyMessage, entityResolutionInstructions, entityFinalSelectorInstructions, orchestratorMessage, generalOneShotInstructions.

## Parameters

*No parameters.*

## Response

```ts
{
  generalInstructions: string | null;
  conceptMessage: string | null;
  relationshipMessage: string | null;
  propertyMessage: string | null;
  entityResolutionInstructions: string | null;
  entityFinalSelectorInstructions: string | null;
  orchestratorMessage: string | null;
  generalOneShotInstructions: string | null;
}
```

## Example

```json
// get_ql_instructions({})
{}
```

Response (arrays truncated):

```json
{
  "generalInstructions": "If a question asks about variants, diseases, and genes, make sure to add in the concept 'VariantAssociation', as well as the relationships 'has association' and 'prioritized to act through'.\nWhen aske…",
  "conceptMessage": null,
  "relationshipMessage": "when 'study the disease' is mentioned use the relationship 'studies the disease'",
  "propertyMessage": "When 'dependency score' is mentioned use the data property 'dependency_score' in the relationship 'has dependency'. \n",
  "entityResolutionInstructions": "'ALS' stands for 'amyotrophic lateral sclerosis' (uuid \"EFO:0001356\" and \"MONDO:0004976\" as two nodes exist). 'TNBC' stands for 'triple-negative breast cancer' (uuid \"EFO:0005537\"). 'IPF' stands for '…",
  "entityFinalSelectorInstructions": "'ALS' stands for 'amyotrophic lateral sclerosis' (uuid \"EFO:0001356\" and \"MONDO:0004976\" as two nodes exist). ;TNBC' stands for 'triple-negative breast cancer' (uuid \"EFO:0005537\"). 'IPF' stands for '…",
  "orchestratorMessage": "'ALS' stands for 'amyotrophic lateral sclerosis' (uuid \"EFO:0001356\" and \"MONDO:0004976\" as two nodes exist). 'TNBC' stands for 'triple-negative breast cancer' (uuid \"EFO:0005537\"). 'IPF' stands for '…",
  "generalOneShotInstructions": null
}
```