Documentation for AI assistants
Documentation for AI assistants
Section titled “Documentation for AI assistants”Documentation is not a skill. A host plugin hands ai a documentation
catalogue (@scfloworg/docs, or a function returning the current one, such as
ctx.docs.catalogue) with registerDocsCatalog(pluginId, catalogue); one host
at a time. An assistant opts in with useDocs (ui.json or
createAssistant): true reads the user topics, { "audience": "plugin-dev" }
(one value or a list) asks for others. Omitted means no documentation.
The assistant then has the ordinary read tool read_docs beside use_skill:
{ query } searches, { topicId } reads one topic. It runs without approval,
adds no action and sees only the audience the assistant asked for.
Documentation under CC BY 4.0 · © SCFlow contributors ·Back to supplychainflow.org