Skip to content
AssureSwarm Docs

Agent Operating Guide

/coach-ask

Natural-language Q&A about how AssureSwarm works, grounded in the plugin's bundled docs snapshot, with every answer citing the doc file and section it came from.

Ask a plain-language question about how AssureSwarm works and get a short, cited answer. The skill dispatches the coach-doc-searcher helper agent to retrieve the most relevant sections of the docs snapshot bundled with the plugin, reads the top matches, and synthesizes a one-to-three-sentence answer followed by a Sources list naming the doc file and section each claim came from. It works offline and is answers-only: it reads the bundled docs and never writes to your tenant.

When to use

Section titled “When to use”

When you have a conceptual “how does this work” question: how a change gets approved, what a tsvector is for, or how the MCP write flow is gated. For a numbered procedure to actually do a task, use /coach-howto; for a single term’s definition, use /coach-glossary; when you’re staring at an error, use /coach-troubleshoot.

Inputs

Section titled “Inputs”
Flag Required Notes
--scope <topic> No Narrow retrieval to one area: concepts, admin, mcp, graphql, or getting-started.

Example

Section titled “Example”

/coach-ask how does a change get approved before it lands? retrieves the suggestions section of the snapshot, then answers in a sentence or two, a write goes in as a pending suggestion an admin approves, under a Sources heading citing the suggestions doc and its section.

Good to know

Section titled “Good to know”
  • Answers are grounded only in the bundled snapshot, so they can lag the live product. The snapshot’s freshness date lives in its _snapshot.json; if an answer describes behavior that has since changed, flag it with /coach-ticket-open.
  • If the docs don’t cover your question, the skill says so plainly rather than guessing, and offers to escalate: it won’t invent an answer.
  • It’s for conceptual questions. Task-shaped (“how do I add a field”) and error-shaped (“I got this error”) questions are better served by the siblings below.
Section titled “Related”