Documentation

API Platform ships the Scrydon documentation inside its image: these same pages, in English and French, as plain text. Two operations search and read it where your installation runs, so an air-gapped installation can answer questions about Scrydon from the pages for the release it runs, without reaching this site.

import { createHttpPlatformTransport, createScrydonSDK } from '@scrydon/sdk/platform'

const platform = createScrydonSDK(
  createHttpPlatformTransport({
    baseUrl: 'https://scrydon.com',
    headers: () => ({ authorization: `Bearer ${accessToken}` }),
  })
)

const { available, hits } = await platform.data.docs.search({ query: 'create an automation' })
if (available && hits[0]) {
  const { found, page } = await platform.data.docs.read({ path: hits[0].path })
  if (found && page) console.log(page.title, page.truncated ? '(cut)' : '', page.text)
}

Both need tools:read. They are read-only and safe to retry. The documentation is the same for every organization and holds no organization data. Nothing is sent outside the platform.

In a workflow, select the Scrydon tools Search Scrydon docs and Read Scrydon docs page in an Agent block's tools. Inside a Scrydon tool, the same operations are ctx.data.docs.search and ctx.data.docs.read. Cortex uses these tools in workspace rooms to answer how Scrydon works.

Search

The result is { available, hits }. Each hit has:

Titles and headings weigh more than words in the body. A French search that finds nothing searches English instead, so its hits then carry locale: 'en'. A query that matches nothing returns available: true with no hits.

Read

The result is { available, found, page }. When found is true, page has path, title, description (when the page has one), locale, text and truncated.

• French falls back to English. Asking for a page in French that has no French version returns the English page, with locale: 'en'.
• The text is capped at 24,000 bytes (UTF-8). A longer page is cut on a character boundary and truncated is true. The cut is never in the middle of a character.
• The text is plain. Headings, prose, table cells and code blocks are kept. Markup, components and images are dropped, and a link keeps only its text.

A path that names no page returns available: true, found: false, with no page.

@scrydon/sdk/platform exports the bounds (DOCS_SEARCH_QUERY_MAX_CHARS, DOCS_SEARCH_LIMIT_MAX, DOCS_SEARCH_LIMIT_DEFAULT, DOCS_PAGE_PATH_MAX_CHARS, DOCS_READ_TEXT_MAX_BYTES) and the locales (DOCS_LOCALES, DOCS_DEFAULT_LOCALE). Unknown fields, including an organization or workspace field, are refused.

When the documentation is not installed

An image built without the documentation answers available: false instead of an error: a search returns no hits, and a read returns found: false. Say that the documentation is not installed instead of failing.

Errors

INVALID_REQUEST means the input did not pass validation, for example a blank query, a limit of 11, or an unknown locale. When a Scrydon tool calls data.docs.search, your organization's data loss prevention policy applies to the query.