agentleFS
stackqlstackql/stackql-skills/skills/stackql-docs/SKILL.md

stackql-docs

Skill0 starsChanged 8 months agoMITView on GitHub

Search StackQL documentation, provider registry docs, and blog posts. Fetches content from stackql.io/docs, registry.stackql.io, and provider-specific doc sites.

The file

We split this skill into the rules it gives an agent

7 rules. About 0 are common, 5 are distinctive, and 2 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈5

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 2

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Follow these steps in order.

    line 15
  2. Distinctive:

    Use web search to find relevant documentation pages:

    line 47
  3. Very specific:

    Search for: site:stackql.io <query terms> or the appropriate provider site.

    line 49
  4. Very specific:

    If the query is provider-specific, also search: site:<provider>.stackql.io <query terms>

    line 51
  5. Distinctive:

    Use the WebFetch tool to retrieve the documentation page content.

    line 57
  6. Distinctive:

    After presenting the sources, synthesize a concise answer to the user's original question.

    line 96
  7. Distinctive:

    If no relevant documentation was found, suggest:

    line 98

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

You are helping the user find relevant StackQL documentation.

Query: $@

Follow these steps in order.

Step 1 - Classify the query

Determine what kind of documentation the user needs:

  • StackQL core (SQL syntax, CLI flags, commands, general usage) -> search stackql.io/docs
  • Provider-specific (how to query a specific provider, resource schemas, auth for a provider) -> search the provider docs site
  • Registry (available providers, versions) -> search registry.stackql.io
  • Blog/tutorials (how-to guides, examples, use cases) -> search stackql.io/blog
  • stackql-deploy (IaC workflows, manifests, deployment) -> search stackql-deploy.io

Step 2 - Determine the documentation URLs

TopicPrimary URL
Core docshttps://stackql.io/docs
CLI referencehttps://stackql.io/docs/command-line-usage/global-flags
Registry commandshttps://stackql.io/docs/command-line-usage/registry
Provider registryhttps://registry.stackql.io/
Google providerhttps://google.stackql.io/
AWS providerhttps://awscc.stackql.io/
Azure providerhttps://azure.stackql.io/
GitHub providerhttps://github.stackql.io/
Okta providerhttps://okta.stackql.io/
Databricks providerhttps://databricks-workspace.stackql.io/
Snowflake providerhttps://snowflake.stackql.io/
stackql-deployhttps://stackql-deploy.io/docs
Bloghttps://stackql.io/blog

Step 3 - Search for documentation

Use web search to find relevant documentation pages:

Search for: site:stackql.io <query terms> or the appropriate provider site.

If the query is provider-specific, also search: site:<provider>.stackql.io <query terms>

Step 4 - Fetch and extract relevant content

For the most relevant search results (up to 3-4 pages), fetch the page content:

Use the WebFetch tool to retrieve the documentation page content.

Extract the relevant sections that answer the user's question.

Step 5 - Handle common topics directly

For frequently asked topics, you can provide answers from your knowledge:

StackQL SQL syntax basics

  • SELECT reads cloud resources (maps to GET/LIST API calls)
  • INSERT INTO ... SELECT creates resources (maps to POST/PUT)
  • UPDATE ... SET ... WHERE modifies resources (maps to PATCH/PUT)
  • DELETE FROM ... WHERE removes resources (maps to DELETE)
  • EXEC <resource>.<method> runs lifecycle operations (start, stop, etc.)

Provider hierarchy

  • SHOW PROVIDERS; - list installed providers
  • SHOW SERVICES IN <provider>; - list services
  • SHOW RESOURCES IN <provider>.<service>; - list resources
  • DESCRIBE <provider>.<service>.<resource>; - show fields
  • SHOW METHODS IN <provider>.<service>.<resource>; - show methods

CLI usage

  • Interactive: stackql shell --auth="${AUTH}"
  • Non-interactive: stackql exec --auth="${AUTH}" "<SQL>"
  • From file: stackql exec --auth="${AUTH}" -i script.iql
  • Output formats: --output json|csv|table|text

Step 6 - Present results

For each relevant documentation section found, format as:

### <Section title>
<URL>

<Relevant content>

After presenting the sources, synthesize a concise answer to the user's original question. If the documentation directly answers the question, lead with the answer before showing the sources.

If no relevant documentation was found, suggest:

  • Visiting https://stackql.io/docs directly
  • Checking the provider-specific docs site
  • Using /stackql-skills:explore <provider> to discover resources interactively

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.