Reference

Tools

16 read-only tools. This page is built from the server’s own tool list, so it matches what the server accepts. Every example opens in Try, where you can run it. Not sure where to start? Read the workflow.

Find what exists

Which languages and resources there are, and a search across Translation Academy and Translation Words.

list_languages

read-only Run in Try

List languages with tc-ready Door43 resources.

Arguments

  • filter string optional

    Optional substring filter on language code, name or English name.

  • limit integer optional default 50

    Maximum number of results to return (default 50).

  • offset integer optional default 0

    Number of results to skip for pagination (default 0).

Example: All languages

{
  "name": "list_languages",
  "arguments": {}
}
What the assistant is told

List language codes available for Door43 resources. Use this to discover valid BCP-47 codes before calling get_passage, list_resources, or other tools. Returns { code, name, englishName } entries: name is the language's own name, often in its own script, and englishName its English name. Use the filter parameter to narrow results by code or by either name (e.g. filter "es" for Spanish variants, "Bengali" for bn). Limitation: lists languages that have at least one resource — not all languages have every resource type.

JSON Schema
{
  "type": "object",
  "properties": {
    "filter": {
      "description": "Optional substring filter on language code, name or English name. E.g. \"es\" shows Spanish variants; \"Bengali\" finds bn.",
      "type": "string"
    },
    "limit": {
      "default": 50,
      "description": "Maximum number of results to return (default 50). Pass a high value to get all.",
      "type": "integer",
      "minimum": 1,
      "maximum": 9999
    },
    "offset": {
      "default": 0,
      "description": "Number of results to skip for pagination (default 0).",
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    }
  },
  "additionalProperties": false
}

list_resources

read-only Run in Try

Availability summary of resource types for a language.

Arguments

  • language string optional default en

    BCP-47 code of the user's requested language (hi, es, es-419, fr, pt-BR).

  • book string optional

    Optional USFM book code or name (e.g. "TIT", "Titus").

  • reference string optional

    Optional passage reference (e.g. "TIT 1:1").

Example: What English has for Titus

{
  "name": "list_resources",
  "arguments": {
    "language": "en",
    "book": "TIT"
  }
}
What the assistant is told

List which translation resource types are available for a language. Returns an availability summary (type, abbreviation, role) from the Door43 catalog — scripture versions, notes, words, academy, questions, OBS, and original-language sources. Pass language as the user's resource language (e.g. hi) — availability is per-language; do not list English resources when the user asked for another language. Book-scoped entries may include books / bookCount / warning when coverage is partial. Pass optional book or reference to filter out resources that do not cover that book. Use this for discovery: confirm a language has the resources you need before calling get_passage / get_note / etc. Limitation: without book, this is a type-level presence check — not a guarantee every book exists. Empty available/resources arrays mean nothing matched — not an error.

JSON Schema
{
  "type": "object",
  "properties": {
    "language": {
      "default": "en",
      "description": "BCP-47 code of the user's requested language (hi, es, es-419, fr, pt-BR). Do not omit this or use \"en\" when they asked for another language. Gateway languages often have their own TW/TA on Door43. Default \"en\" only when they want English.",
      "type": "string",
      "minLength": 2
    },
    "book": {
      "description": "Optional USFM book code or name (e.g. \"TIT\", \"Titus\"). When set, book-scoped resources (scripture, notes, questions, word links) that list ingredients but omit this book are excluded.",
      "type": "string",
      "minLength": 2,
      "maxLength": 20
    },
    "reference": {
      "description": "Optional passage reference (e.g. \"TIT 1:1\"). Book is extracted and used like `book`.",
      "type": "string",
      "minLength": 2
    }
  },
  "additionalProperties": false
}

search_articles

read-only Run in Try

Lexical search across TA and TW articles.

Arguments

  • query string required

    Search term or concept.

  • language string optional default en

    BCP-47 code of the user's requested language (hi, es, es-419, fr, pt-BR).

  • limit integer optional default 10

    Maximum number of results (default 10).

  • types string optional

    Comma-separated resource types: "ta", "tw", or "ta,tw" (default all). resourceType and type are aliases.

Example: Search articles: “metaphor”

{
  "name": "search_articles",
  "arguments": {
    "query": "metaphor",
    "language": "en"
  }
}
What the assistant is told

LATERAL: Find Translation Academy or Translation Words articles by concept or keyword. Use this to locate an article when you know the concept (e.g. 'metaphor', 'abstract nouns', 'covenant') but not the path, or when no article is linked to the current passage. Pass language as the user's resource language — search that language's TW/TA catalog, not English, unless the user asked for English. Returns { path, title, resourceType }[] sorted by relevance. Pass path to get_academy_article (resourceType:"ta") or get_word_article (resourceType:"tw"). Empty results: [] when nothing matches — not an error.

JSON Schema
{
  "type": "object",
  "properties": {
    "query": {
      "type": "string",
      "minLength": 1,
      "description": "Search term or concept. E.g. \"abstract nouns\", \"metaphor\", \"covenant\", \"grace\", \"righteousness\". Returns the most relevant TA and TW articles. Pass `path` to `get_academy_article` or `get_word_article`."
    },
    "language": {
      "default": "en",
      "description": "BCP-47 code of the user's requested language (hi, es, es-419, fr, pt-BR). Do not omit this or use \"en\" when they asked for another language. Gateway languages often have their own TW/TA on Door43. Default \"en\" only when they want English.",
      "type": "string",
      "minLength": 2
    },
    "limit": {
      "default": 10,
      "description": "Maximum number of results (default 10).",
      "type": "integer",
      "minimum": 1,
      "maximum": 30
    },
    "types": {
      "description": "Comma-separated resource types: \"ta\", \"tw\", or \"ta,tw\" (default all). resourceType and type are aliases.",
      "type": "string"
    }
  },
  "required": [
    "query"
  ],
  "additionalProperties": false
}

Work through a passage

The text, its background, a map of the helps, and the questions that check a draft.

get_passage

read-only Run in Try

Scripture text for a reference (literal + simplified + original).

Arguments

  • reference string required

    A full Bible passage: book name (or USFM code) + chapter + verse or verse range.

  • language string optional default en

    BCP-47 code of the user's requested language (hi, es, es-419, fr, pt-BR).

  • format enum optional default text

    "text" = plain prose (default), "usfm" = raw USFM markup.

    text · usfm

Example: John 3:16

{
  "name": "get_passage",
  "arguments": {
    "reference": "John 3:16",
    "language": "en"
  }
}
What the assistant is told

STEP 1a (orient — text): Fetch the scripture TEXT for a passage — the literal, the simplified and the original version in one call. Returns versions[], each labeled by role: literal (word-for-word, e.g. ULT), simplified (meaning-based, e.g. UST), and original (Hebrew/Greek source, always included). When the literal or the simplified version does not have the book yet, or its id line says the book is in another language, or the text is written in another script, another version of the language stands in with role:other and versionsNote says which was replaced and why: tell the reader. Use role:literal to translate form and role:simplified to translate meaning; compare against role:original for the source wording. Optional format: "text" (default) or "usfm" for raw markup. Call this FIRST when studying or translating a passage — it also warms the server cache for all subsequent steps. It is cheap and repeatable: re-call it any time you need to re-read the verse while studying or drafting. After this → call get_passage_context (Step 1b) for background notes, then get_passage_index (Step 2) to survey translation issues. When scripture is missing for the language/book: soft-fail with RESOURCE_NOT_AVAILABLE (isError:false), not a hard error.

JSON Schema
{
  "type": "object",
  "properties": {
    "reference": {
      "type": "string",
      "minLength": 3,
      "description": "A full Bible passage: book name (or USFM code) + chapter + verse or verse range. The book MUST be accompanied by chapter/verse — a bare book code is invalid. The book name may be localized when it matches the `language` parameter. Examples: \"JHN 3:16\", \"John 3:16\", \"Juan 3:16\" (language:\"es\"), \"GEN 1:1-3\", \"MAT 5\" (full chapter). Decomposed arguments {book, chapter, verse} and common non-standard codes (MAR, 2KGS) are also accepted."
    },
    "language": {
      "default": "en",
      "description": "BCP-47 code of the user's requested language (hi, es, es-419, fr, pt-BR). Do not omit this or use \"en\" when they asked for another language. Gateway languages often have their own TW/TA on Door43. Default \"en\" only when they want English.",
      "type": "string",
      "minLength": 2
    },
    "format": {
      "default": "text",
      "description": "\"text\" = plain prose (default), \"usfm\" = raw USFM markup.",
      "type": "string",
      "enum": [
        "text",
        "usfm"
      ]
    }
  },
  "required": [
    "reference"
  ],
  "additionalProperties": false
}

get_passage_context

read-only Run in Try

Background notes and resource availability for a passage.

Arguments

  • reference string required

    A Bible passage OR a bare book name.

  • language string optional default en

    BCP-47 code of the user's requested language (hi, es, es-419, fr, pt-BR).

Example: Background of Titus

{
  "name": "get_passage_context",
  "arguments": {
    "reference": "Titus",
    "language": "en"
  }
}
What the assistant is told

STEP 1b (orient — background): Load the background AROUND a passage — book/chapter introductions and a summary of which resources exist. Returns context[] with book-level and chapter-level intro notes (each tagged scope:"book" or scope:"chapter" — cultural background, overview, themes) and availability listing which resource types exist for this language (filtered to the reference book when catalog ingredients allow). Also accepts a BARE BOOK reference (e.g. "TIT" or "Titus") — then returns only the book overview (front:intro), ideal when the user names a whole book. This does NOT return the verse text — use get_passage for that. When studying a passage step by step, call get_passage for the text, then this once for the background, then get_passage_index to survey the verses. Empty context / availability arrays mean nothing is available — not an error. Partial upstream failures may set notesError / availabilityError while still returning isError:false.

JSON Schema
{
  "type": "object",
  "properties": {
    "reference": {
      "type": "string",
      "minLength": 3,
      "description": "A Bible passage OR a bare book name. With chapter (\"TIT 1\", \"JHN 3:16\") returns book + chapter intro notes. With only a book name or USFM code (\"TIT\", \"Titus\", \"1 John\") returns just the book overview (front:intro). The book name may be localized when it matches the `language` parameter."
    },
    "language": {
      "default": "en",
      "description": "BCP-47 code of the user's requested language (hi, es, es-419, fr, pt-BR). Do not omit this or use \"en\" when they asked for another language. Gateway languages often have their own TW/TA on Door43. Default \"en\" only when they want English.",
      "type": "string",
      "minLength": 2
    }
  },
  "required": [
    "reference"
  ],
  "additionalProperties": false
}

get_passage_index

read-only Run in Try

Survey translation notes and key terms for a passage.

Arguments

  • reference string required

    A full Bible passage: book name (or USFM code) + chapter + verse or verse range.

  • language string optional default en

    BCP-47 code of the user's requested language (hi, es, es-419, fr, pt-BR).

  • skipNotes boolean optional

    When true, skip the /notes fetch and return empty notes[]/issues[].

Example: Titus 1:1 helps map

{
  "name": "get_passage_index",
  "arguments": {
    "reference": "Titus 1:1",
    "language": "en"
  }
}
What the assistant is told

Survey a passage: a compact index of translation notes and key terms, with no article bodies. Each note row has quote.aligned and taArticle.{path,title}. Each word row has quote.aligned and twArticle.{path,category,title}. keyTerms[].category is the path's own category (kt, names, or other). issues[] and keyTerms[] are the deduplicated rollups. When studying a passage step by step, call this after get_passage_context, then drill with get_note(id), get_academy_article(taArticle.path), or get_word_article(twArticle.path). A direct question about a term, a concept, the notes, or the questions does not need this index first. Use search_articles for a concept that is not linked to this passage. Empty arrays mean this passage has none. notesAvailable: false means this language has no notes for that book; the word links in this result are still real, so say so and do not answer from memory. available: false means neither notes nor word links are available.

JSON Schema
{
  "type": "object",
  "properties": {
    "reference": {
      "type": "string",
      "minLength": 3,
      "description": "A full Bible passage: book name (or USFM code) + chapter + verse or verse range. The book MUST be accompanied by chapter/verse — a bare book code is invalid. The book name may be localized when it matches the `language` parameter. Examples: \"JHN 3:16\", \"John 3:16\", \"Juan 3:16\" (language:\"es\"), \"GEN 1:1-3\", \"MAT 5\" (full chapter). Decomposed arguments {book, chapter, verse} and common non-standard codes (MAR, 2KGS) are also accepted."
    },
    "language": {
      "default": "en",
      "description": "BCP-47 code of the user's requested language (hi, es, es-419, fr, pt-BR). Do not omit this or use \"en\" when they asked for another language. Gateway languages often have their own TW/TA on Door43. Default \"en\" only when they want English.",
      "type": "string",
      "minLength": 2
    },
    "skipNotes": {
      "description": "When true, skip the /notes fetch and return empty notes[]/issues[]. Use when get_note is already called in the same turn — only word-links are needed.",
      "type": "boolean"
    }
  },
  "required": [
    "reference"
  ],
  "additionalProperties": false
}

get_questions

read-only Run in Try

Translation questions for a passage.

Arguments

  • reference string required

    A full Bible passage: book name (or USFM code) + chapter + verse or verse range.

  • language string optional default en

    BCP-47 code of the user's requested language (hi, es, es-419, fr, pt-BR).

Example: Questions on Titus 1:1

{
  "name": "get_questions",
  "arguments": {
    "reference": "Titus 1:1",
    "language": "en"
  }
}
What the assistant is told

Fetch Translation Questions for a verse. For a direct question about the questions for a passage, call this with the reference. When studying a passage step by step, use it after a translation draft to check that the meaning came through. Returns questions[] with { reference, question, response }. response is the expected answer. Empty questions: [] means this verse has none. available: false means this language has no questions for that book: say so and do not answer from memory.

JSON Schema
{
  "type": "object",
  "properties": {
    "reference": {
      "type": "string",
      "minLength": 3,
      "description": "A full Bible passage: book name (or USFM code) + chapter + verse or verse range. The book MUST be accompanied by chapter/verse — a bare book code is invalid. The book name may be localized when it matches the `language` parameter. Examples: \"JHN 3:16\", \"John 3:16\", \"Juan 3:16\" (language:\"es\"), \"GEN 1:1-3\", \"MAT 5\" (full chapter). Decomposed arguments {book, chapter, verse} and common non-standard codes (MAR, 2KGS) are also accepted."
    },
    "language": {
      "default": "en",
      "description": "BCP-47 code of the user's requested language (hi, es, es-419, fr, pt-BR). Do not omit this or use \"en\" when they asked for another language. Gateway languages often have their own TW/TA on Door43. Default \"en\" only when they want English.",
      "type": "string",
      "minLength": 2
    }
  },
  "required": [
    "reference"
  ],
  "additionalProperties": false
}

Open one help

The full note or article, once the map has shown which ones matter.

get_note

read-only Run in Try

Full translation note bodies for a passage.

Arguments

  • reference string required

    A full Bible passage: book name (or USFM code) + chapter + verse or verse range.

  • language string optional default en

    BCP-47 code of the user's requested language (hi, es, es-419, fr, pt-BR).

  • id string optional

    The note ID from get_passage_index notes[].id.

  • phrase string optional

    A word or phrase from the strategic-language text (e.g. 'teaching us', 'instruyéndonos').

Example: Notes on Titus 1:1

{
  "name": "get_note",
  "arguments": {
    "reference": "Titus 1:1",
    "language": "en"
  }
}
What the assistant is told

Fetch the full body of translation notes for a verse. For a direct question about the notes, call this with the reference. Each note has book (USFM code), note, supportReference (an rc:// Translation Academy link), and taArticle.{path,title}. Pass taArticle.path to get_academy_article. The rc:// form is also accepted; taArticle.path is the path to reuse. Verse links in the note are references such as Genesis 1:29. rc://*/tn/help/... is a note reference, not an article path. When studying a passage step by step, pass id from get_passage_index. Pass phrase to match a strategic-language phrase against quote and the note body. Empty notes: [] when none match — not an error. available: false means this language has no notes for that book: say so and do not answer from memory.

JSON Schema
{
  "type": "object",
  "properties": {
    "reference": {
      "type": "string",
      "minLength": 3,
      "description": "A full Bible passage: book name (or USFM code) + chapter + verse or verse range. The book MUST be accompanied by chapter/verse — a bare book code is invalid. The book name may be localized when it matches the `language` parameter. Examples: \"JHN 3:16\", \"John 3:16\", \"Juan 3:16\" (language:\"es\"), \"GEN 1:1-3\", \"MAT 5\" (full chapter). Decomposed arguments {book, chapter, verse} and common non-standard codes (MAR, 2KGS) are also accepted."
    },
    "language": {
      "default": "en",
      "description": "BCP-47 code of the user's requested language (hi, es, es-419, fr, pt-BR). Do not omit this or use \"en\" when they asked for another language. Gateway languages often have their own TW/TA on Door43. Default \"en\" only when they want English.",
      "type": "string",
      "minLength": 2
    },
    "id": {
      "description": "The note ID from `get_passage_index` notes[].id. If omitted, all notes for the reference are returned (unless `phrase` is given).",
      "type": "string"
    },
    "phrase": {
      "description": "A word or phrase from the strategic-language text (e.g. 'teaching us', 'instruyéndonos'). When provided, only notes whose `quote` field contains this phrase (case-insensitive) OR whose `note` body mentions it are returned. Use this to find the exact note that covers a phrase the user wants to explore — the `quote` field holds the original-language words the note addresses.",
      "type": "string"
    }
  },
  "required": [
    "reference"
  ],
  "additionalProperties": false
}

get_academy_article

read-only Run in Try

Fetch a Translation Academy article by path.

Arguments

  • path string required

    Exact path is best (translate/figs-metaphor). figs-metaphor, metaphor, and rc://*/ta/man/translate/figs-metaphor also work.

  • language string optional default en

    BCP-47 code of the user's requested language (hi, es, es-419, fr, pt-BR).

Example: Article: metaphor

{
  "name": "get_academy_article",
  "arguments": {
    "path": "translate/figs-metaphor",
    "language": "en"
  }
}
What the assistant is told

Fetch a Translation Academy article: how to translate a figure, a grammar point, or a checking step. For a direct question about a translation concept, pass the term or call search_articles. An exact path is best; figs-metaphor and metaphor also work and are resolved (the answer includes path, requestedPath, and resolvedFrom). Pass language as the user's language, not en, when they asked for another one. When studying a passage step by step, take path from get_note or get_passage_index notes[].taArticle.path. Links in the article are paths this tool accepts (translate/figs-simile). rc://*/tn/help/... links are note references, not article paths. related[] lists the article links. Several matches return candidates — call again with one path. Missing article: soft-fail RESOURCE_NOT_AVAILABLE (isError:false).

JSON Schema
{
  "type": "object",
  "properties": {
    "path": {
      "type": "string",
      "minLength": 1,
      "description": "Exact path is best (translate/figs-metaphor). figs-metaphor, metaphor, and rc://*/ta/man/translate/figs-metaphor also work."
    },
    "language": {
      "default": "en",
      "description": "BCP-47 code of the user's requested language (hi, es, es-419, fr, pt-BR). Do not omit this or use \"en\" when they asked for another language. Gateway languages often have their own TW/TA on Door43. Default \"en\" only when they want English.",
      "type": "string",
      "minLength": 2
    }
  },
  "required": [
    "path"
  ],
  "additionalProperties": false
}

get_word_article

read-only Run in Try

Fetch a Translation Words article by path.

Arguments

  • path string required

    Exact path is best (bible/kt/covenant). covenant, sheol, son of god, and bible/other/hades also work.

  • language string optional default en

    BCP-47 code of the user's requested language (hi, es, es-419, fr, pt-BR).

Example: Key term: God

{
  "name": "get_word_article",
  "arguments": {
    "path": "bible/kt/god",
    "language": "en"
  }
}
What the assistant is told

Fetch a Translation Words article: what a biblical term means and how to translate it. For a direct question about a term, pass the term. An exact path is best; covenant, sheol, son of god, and bible/other/hades also work and are resolved (the answer includes path, requestedPath, and resolvedFrom). Pass language as the user's language, not en, when they asked for another one. When studying a passage step by step, take path from get_passage_index words[].twArticle.path or from search_articles. Links in the article are paths this tool accepts (bible/kt/promise). rc://*/tn/help/... links are note references, not article paths. related[] lists the article links. Several matches return candidates — call again with one path. Missing article: soft-fail RESOURCE_NOT_AVAILABLE (isError:false).

JSON Schema
{
  "type": "object",
  "properties": {
    "path": {
      "type": "string",
      "minLength": 1,
      "description": "Exact path is best (bible/kt/covenant). covenant, sheol, son of god, and bible/other/hades also work."
    },
    "language": {
      "default": "en",
      "description": "BCP-47 code of the user's requested language (hi, es, es-419, fr, pt-BR). Do not omit this or use \"en\" when they asked for another language. Gateway languages often have their own TW/TA on Door43. Default \"en\" only when they want English.",
      "type": "string",
      "minLength": 2
    }
  },
  "required": [
    "path"
  ],
  "additionalProperties": false
}

Open Bible Stories

A story, its notes, key terms, questions, and its study notes and questions.

get_obs_story

read-only Run in Try

Open Bible Stories story text.

Arguments

  • reference string required

    An OBS story:frame reference.

  • language string optional default en

    BCP-47 code of the user's requested language (hi, es, es-419, fr, pt-BR).

Example: OBS story 1

{
  "name": "get_obs_story",
  "arguments": {
    "reference": "1",
    "language": "en"
  }
}
What the assistant is told

Fetch Open Bible Stories (OBS) text for a specific story and frame. OBS is a set of 50 illustrated Bible stories designed for communities without written Scripture. Returns the story title and one or more frame objects, each containing the frame text and image URL. Use reference "1:1" for story 1, frame 1; "3:1-3" for frames 1–3; "2" for all frames of story 2. Use get_obs_notes and get_obs_questions for translation helps on the same reference, get_obs_index for that frame's key terms, and get_obs_study_notes and get_obs_study_questions for study helps. Missing OBS for the language: soft-fail with RESOURCE_NOT_AVAILABLE (isError:false).

JSON Schema
{
  "type": "object",
  "properties": {
    "reference": {
      "type": "string",
      "minLength": 1,
      "description": "An OBS story:frame reference. Examples: \"1:1\" (single frame), \"3:1-3\" (frames 1–3 inclusive), \"3\" (whole story), \"1:0\" (story title), \"front\" (front matter). Optional \"OBS\" prefix (\"OBS 3:1-3\"). Story numbers 1–50; frames are 1-indexed. Inverted ranges (e.g. \"3:5-2\") are invalid. `story` and `frame` as separate numbers are also accepted."
    },
    "language": {
      "default": "en",
      "description": "BCP-47 code of the user's requested language (hi, es, es-419, fr, pt-BR). Do not omit this or use \"en\" when they asked for another language. Gateway languages often have their own TW/TA on Door43. Default \"en\" only when they want English.",
      "type": "string",
      "minLength": 2
    }
  },
  "required": [
    "reference"
  ],
  "additionalProperties": false
}

get_obs_notes

read-only Run in Try

OBS translation notes for a story:frame.

Arguments

  • reference string required

    An OBS story:frame reference.

  • language string optional default en

    BCP-47 code of the user's requested language (hi, es, es-419, fr, pt-BR).

Example: OBS story 1 notes

{
  "name": "get_obs_notes",
  "arguments": {
    "reference": "1",
    "language": "en"
  }
}
What the assistant is told

Fetch Open Bible Stories Translation Notes (OBS-TN) for a story:frame reference. OBS-TN notes explain difficult words, cultural context, and translation strategies for each frame of the 50 OBS stories — analogous to TN for Bible passages. Use reference "1:1" for frame-specific notes, or "1" for all notes in a story. Pairs with get_obs_story for the story text. Call get_obs_index for that frame's key terms. Missing OBS-TN for the language: soft-fail with RESOURCE_NOT_AVAILABLE (isError:false).

JSON Schema
{
  "type": "object",
  "properties": {
    "reference": {
      "type": "string",
      "minLength": 1,
      "description": "An OBS story:frame reference. Examples: \"1:1\" (single frame), \"3:1-3\" (frames 1–3 inclusive), \"3\" (whole story), \"1:0\" (story title), \"front\" (front matter). Optional \"OBS\" prefix (\"OBS 3:1-3\"). Story numbers 1–50; frames are 1-indexed. Inverted ranges (e.g. \"3:5-2\") are invalid. `story` and `frame` as separate numbers are also accepted."
    },
    "language": {
      "default": "en",
      "description": "BCP-47 code of the user's requested language (hi, es, es-419, fr, pt-BR). Do not omit this or use \"en\" when they asked for another language. Gateway languages often have their own TW/TA on Door43. Default \"en\" only when they want English.",
      "type": "string",
      "minLength": 2
    }
  },
  "required": [
    "reference"
  ],
  "additionalProperties": false
}

get_obs_index

read-only Run in Try

Compact index of OBS notes and key terms for a story:frame (no article bodies).

Arguments

  • reference string required

    An OBS story:frame reference.

  • language string optional default en

    BCP-47 code of the user's requested language (hi, es, es-419, fr, pt-BR).

Example: OBS story 1 key terms

{
  "name": "get_obs_index",
  "arguments": {
    "reference": "1:3",
    "language": "en"
  }
}
What the assistant is told

Compact index of OBS translation notes and key terms for a story:frame — NO article bodies. notes[] has reference, id, quote, occurrence, and taArticle.{path,title}. words[] has each key-term row with twArticle.{path,category,title}; keyTerms[] rolls those up by path with a count and the frames. A failed fetch sets notesError or wordLinksError; that is not a missing resource. available:false only when neither resource exists. Pass twArticle.path to get_word_article. Full notes are get_obs_notes.

JSON Schema
{
  "type": "object",
  "properties": {
    "reference": {
      "type": "string",
      "minLength": 1,
      "description": "An OBS story:frame reference. Examples: \"1:1\" (single frame), \"3:1-3\" (frames 1–3 inclusive), \"3\" (whole story), \"1:0\" (story title), \"front\" (front matter). Optional \"OBS\" prefix (\"OBS 3:1-3\"). Story numbers 1–50; frames are 1-indexed. Inverted ranges (e.g. \"3:5-2\") are invalid. `story` and `frame` as separate numbers are also accepted."
    },
    "language": {
      "default": "en",
      "description": "BCP-47 code of the user's requested language (hi, es, es-419, fr, pt-BR). Do not omit this or use \"en\" when they asked for another language. Gateway languages often have their own TW/TA on Door43. Default \"en\" only when they want English.",
      "type": "string",
      "minLength": 2
    }
  },
  "required": [
    "reference"
  ],
  "additionalProperties": false
}

get_obs_questions

read-only Run in Try

OBS translation questions for a story:frame.

Arguments

  • reference string required

    An OBS story:frame reference.

  • language string optional default en

    BCP-47 code of the user's requested language (hi, es, es-419, fr, pt-BR).

Example: OBS story 1 questions

{
  "name": "get_obs_questions",
  "arguments": {
    "reference": "1",
    "language": "en"
  }
}
What the assistant is told

Fetch Open Bible Stories Translation Questions (OBS-TQ) for a story:frame reference. OBS-TQ provides comprehension questions and expected answers for each frame of the 50 OBS stories. Use these after a translator has produced a draft to verify the translation conveys the correct meaning. Use reference "1:1" for frame-level questions, or "1" for all questions in a story. Pairs with get_obs_story to provide the story text context. Missing OBS-TQ for the language: soft-fail with RESOURCE_NOT_AVAILABLE (isError:false).

JSON Schema
{
  "type": "object",
  "properties": {
    "reference": {
      "type": "string",
      "minLength": 1,
      "description": "An OBS story:frame reference. Examples: \"1:1\" (single frame), \"3:1-3\" (frames 1–3 inclusive), \"3\" (whole story), \"1:0\" (story title), \"front\" (front matter). Optional \"OBS\" prefix (\"OBS 3:1-3\"). Story numbers 1–50; frames are 1-indexed. Inverted ranges (e.g. \"3:5-2\") are invalid. `story` and `frame` as separate numbers are also accepted."
    },
    "language": {
      "default": "en",
      "description": "BCP-47 code of the user's requested language (hi, es, es-419, fr, pt-BR). Do not omit this or use \"en\" when they asked for another language. Gateway languages often have their own TW/TA on Door43. Default \"en\" only when they want English.",
      "type": "string",
      "minLength": 2
    }
  },
  "required": [
    "reference"
  ],
  "additionalProperties": false
}

get_obs_study_notes

read-only Run in Try

OBS study notes for a story:frame (reader background, not translator TN).

Arguments

  • reference string required

    An OBS story:frame reference.

  • language string optional default en

    BCP-47 code of the user's requested language (hi, es, es-419, fr, pt-BR).

Example: OBS story 1 study notes

{
  "name": "get_obs_study_notes",
  "arguments": {
    "reference": "1",
    "language": "en"
  }
}
What the assistant is told

Fetch Open Bible Stories Study Notes (OBS-SN) for a story:frame reference. OBS-SN explains the story for readers and discussion groups — background on people, places, and ideas in each frame — unlike OBS-TN (get_obs_notes), which targets translators with quotes, support references, and translation strategies. Use reference "1:1" for frame-specific notes, or "1" for all notes in a story. Pairs with get_obs_story and get_obs_study_questions. Missing OBS-SN for the language: soft-fail with RESOURCE_NOT_AVAILABLE (isError:false).

JSON Schema
{
  "type": "object",
  "properties": {
    "reference": {
      "type": "string",
      "minLength": 1,
      "description": "An OBS story:frame reference. Examples: \"1:1\" (single frame), \"3:1-3\" (frames 1–3 inclusive), \"3\" (whole story), \"1:0\" (story title), \"front\" (front matter). Optional \"OBS\" prefix (\"OBS 3:1-3\"). Story numbers 1–50; frames are 1-indexed. Inverted ranges (e.g. \"3:5-2\") are invalid. `story` and `frame` as separate numbers are also accepted."
    },
    "language": {
      "default": "en",
      "description": "BCP-47 code of the user's requested language (hi, es, es-419, fr, pt-BR). Do not omit this or use \"en\" when they asked for another language. Gateway languages often have their own TW/TA on Door43. Default \"en\" only when they want English.",
      "type": "string",
      "minLength": 2
    }
  },
  "required": [
    "reference"
  ],
  "additionalProperties": false
}

get_obs_study_questions

read-only Run in Try

OBS study questions for a story:frame (ranges like 1:1-8 cover a 1:3 request).

Arguments

  • reference string required

    An OBS story:frame reference.

  • language string optional default en

    BCP-47 code of the user's requested language (hi, es, es-419, fr, pt-BR).

Example: OBS story 1 study questions

{
  "name": "get_obs_study_questions",
  "arguments": {
    "reference": "1",
    "language": "en"
  }
}
What the assistant is told

Fetch Open Bible Stories Study Questions (OBS-SQ) for a story:frame reference. OBS-SQ provides meaning, application, and summary questions for discussion groups — rows often cover a RANGE of frames (e.g. "1:1-8"), so a request for "1:3" returns every question whose range covers that frame (same as v1). Unlike OBS-TQ (get_obs_questions), which checks translator comprehension frame-by-frame. Use reference "1:3" for questions covering that frame, or "1" for the whole story. Pairs with get_obs_story and get_obs_study_notes. Missing OBS-SQ for the language: soft-fail with RESOURCE_NOT_AVAILABLE (isError:false).

JSON Schema
{
  "type": "object",
  "properties": {
    "reference": {
      "type": "string",
      "minLength": 1,
      "description": "An OBS story:frame reference. Examples: \"1:1\" (single frame), \"3:1-3\" (frames 1–3 inclusive), \"3\" (whole story), \"1:0\" (story title), \"front\" (front matter). Optional \"OBS\" prefix (\"OBS 3:1-3\"). Story numbers 1–50; frames are 1-indexed. Inverted ranges (e.g. \"3:5-2\") are invalid. `story` and `frame` as separate numbers are also accepted."
    },
    "language": {
      "default": "en",
      "description": "BCP-47 code of the user's requested language (hi, es, es-419, fr, pt-BR). Do not omit this or use \"en\" when they asked for another language. Gateway languages often have their own TW/TA on Door43. Default \"en\" only when they want English.",
      "type": "string",
      "minLength": 2
    }
  },
  "required": [
    "reference"
  ],
  "additionalProperties": false
}