Available Skills

These are the official skills in scoutos/scout-skills. They cover Scout data APIs and workflow execution.

Install the Skill Pack

npx skills add scoutos/scout-skills

Set your API key before using the Scout endpoints:

export SCOUT_API_KEY="your-api-key-here"

Get your API key from Scout Dashboard  -> Settings -> API Keys.

Scout API Skill

Use scout when the task is about data operations in Scout.

Capabilities

Sync Sources

The Scout skill supports syncing data from various external sources:

When to Use Each Source

Website Crawler: Best for general documentation sites and public content.

Sitemap: Use this when you have a comprehensive sitemap.xml and want predictable crawling.

Notion: Use this for syncing internal documentation, wikis or knowledge bases.

Google Drive: Use this when your content lives in Google Docs or Drive folders.

Guided Crawl: Use this for sites requiring login, complex navigation or JavaScript-heavy pages.

Scout Workflow Skill

Use scout-workflow when the task is about creating, running or deploying Scout workflows.

Capabilities

Environments

The workflow skill supports these execution environments:

• production (default)
• staging
• development
• console

Typical prompts for this skill

• “Run workflow wf_abc123 with these inputs”
• “Execute this workflow in staging”
• “Stream workflow output so I can monitor progress”
• “Deploy this workflow with the Scout CLI”

Example Usage

Querying Collections

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

Creating Documents

curl -X POST \
  -H "Authorization: Bearer $SCOUT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '[
    {"title": "Task 1", "completed": false},
    {"title": "Task 2", "completed": true}
  ]' \
  "https://api.scoutos.com/v2/collections/{col_id}/tables/{tbl_id}/documents"

Setting Up a Website Sync

curl -X POST \
  -H "Authorization: Bearer $SCOUT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "sync_config": {
      "source_settings": {
        "source_archetype_id": "com.scoutos.website",
        "start_urls": ["https://docs.example.com"],
        "max_depth": 3,
        "max_page_count": 100
      },
      "destination": {
        "destination_type": "collections.v2",
        "collection_id": "col_abc123",
        "table_id": "tbl_xyz789"
      }
    }
  }' \
  "https://api.scoutos.com/v2/syncs"

Uploading Files to Drive

curl -X POST \
  -H "Authorization: Bearer $SCOUT_API_KEY" \
  -F "files=@report.pdf" \
  "https://api.scoutos.com/drive/upload"

Executing a Workflow

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 Skills with Agents

When an agent has scout enabled, you can ask it to:

• “List all my collections and their tables”
• “Search the knowledge base for documents about API design”
• “Upload this PDF to Drive and make it searchable”
• “Create a new table called Tasks with columns for title, status and due date”
• “Set up a sync from our Notion docs to the knowledge base”

When an agent has scout-workflow enabled, you can also ask it to:

• “Run workflow wf_123 in staging with this payload”
• “Stream workflow output and report status changes”
• “Create a new workflow revision and deploy it”

Additional Resources

• Official Docs: https://docs.scoutos.com 
• API Reference: https://ref.scoutos.com/api-sdk 
• Workflow Docs: https://docs.scoutos.com/docs/workflows 
• Workflow Run Endpoint: https://ref.scoutos.com/api-sdk/endpoints/workflows/run 
• Status Page: https://status.scoutos.com 
• Support: support@scoutos.com

Built with ❤️ by Scout OS