Skip to main content
Scout ships two official, production-ready Skills in the scoutos/scout-skills repository. The scout Skill covers Scout’s core data and platform APIs, while scout-workflow covers workflow execution and management. Install both with a single command and your agents immediately gain access to the full Scout platform.

​
Install the Official Skill Pack

Install both Skills from GitHub using the Scout Skills CLI: 
npx skills add scoutos/scout-skills
Then set your API key so the Skills can authenticate with the Scout API: 
export SCOUT_API_KEY="your-api-key-here"
Get your API key from Scout Studio → Settings → API Keys. Both Skills read SCOUT_API_KEY automatically as a Bearer token — no additional configuration required.

​
The scout Skill

Use the scout Skill when your task involves data operations in Scout: reading and writing databases, managing documents, uploading files, or monitoring usage.

​
Capabilities

FeatureDescription
DatabasesCreate, list, update, and delete top-level data containers
TablesManage structured data with custom schemas (text, number, select, datetime, and more)
DocumentsFull CRUD on table records with bulk insert support
AgentsList agents and invoke them programmatically
DriveUpload and download files to Scout storage
SyncsSync data from external sources including websites, Notion, Google Drive, and more
UsageQuery API usage metrics and quotas for your organization

​
Sync Sources

The scout Skill can configure data syncs from a wide range of external sources:
SourceArchetype IDBest for
Website Crawlercom.scoutos.websiteGeneral documentation sites and public content
Sitemapcom.scoutos.sitemapSites with a comprehensive sitemap.xml
Crawlcom.scoutos.crawlMulti-page crawls across linked pages
Page Crawlcom.scoutos.page_crawlSingle-page content extraction
Notioncom.notion.notionInternal wikis, pages, and databases
Google Drivecom.google.driveGoogle Docs and Drive folders
Microsoft 365com.microsoft.365SharePoint and OneDrive
Laserfichecom.laserfiche.repositoryLaserfiche document repositories
Guided Crawlcom.scoutos.guided_crawlSites requiring login or complex JavaScript navigation

​
Example Prompts

When an agent has the scout Skill enabled, you can ask it:
  • “List all my databases and their tables.”
  • “Search the knowledge base for documents about API design.”
  • “Create a new table called Tasks with columns for title, status, and due date.”
  • “Upload this PDF to Drive and make it searchable.”
  • “Set up a sync from our Notion docs to the knowledge base database.”
  • “Show me API usage for this month.”

​
API Examples

curl -H "Authorization: Bearer $SCOUT_API_KEY" \
  "https://api.scoutos.com/v2/collections"

​
The scout-workflow Skill

Use the scout-workflow Skill when your task involves creating, running, or deploying Scout workflows. This Skill handles everything from triggering a single run to streaming long-running workflow output in real time.

​
Capabilities

FeatureDescription
Workflow executionTrigger runs via POST /v2/workflows/{workflow_id}/execute
Streaming runsConsume real-time streaming output for long-running jobs
RevisionsCreate runs against specific workflow revisions and inspect revision history
SDK supportPython and TypeScript patterns for programmatic workflow execution
CLI workflows as codeLocal run and deployment via scout workflows commands

​
Execution Environments

The scout-workflow Skill supports four execution environments:
EnvironmentUse case
productionLive production runs (default)
stagingPre-production testing
developmentActive development and iteration
consoleInteractive console testing

​
Example Prompts

When an agent has the scout-workflow Skill enabled, you can ask it:
  • “Run workflow wf_abc123 with these inputs.”
  • “Execute the lead-enrichment workflow in staging with this contact payload.”
  • “Stream workflow output so I can monitor progress in real time.”
  • “List all revisions for workflow wf_abc123 and tell me what changed.”
  • “Deploy this workflow definition using the Scout CLI.”

​
API Example

curl -X POST "https://api.scoutos.com/v2/workflows/wf_abc123/execute?environment=production" \
  -H "Authorization: Bearer $SCOUT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "inputs": {
      "user_message": "Generate a weekly summary"
    },
    "streaming": false
  }'

​
Using Both Skills Together

An agent can have both Skills active at the same time. It automatically routes to the right Skill based on the task. For example:
PromptSkill used
”List all documents in the customers database.”scout
”Run the onboarding-workflow for this new user.”scout-workflow
”Upload this file to Drive, then trigger the ingestion workflow.”scout then scout-workflow
”Search the knowledge base and summarize the top results.”scout
”Stream the report-generator workflow output.”scout-workflow

​
Additional Resources

Scout Skills on GitHub

Browse the full source for both official Skills, including complete SKILL.md files and tool definitions.

API Reference

Full reference for all Scout API endpoints used by the official Skills.

Creating Custom Skills

Build a Skill for any API or service your agents need.

Skills Overview

Learn how Skills work and why they make agents more reliable.