scout #

The single entry point for the Scout Application Capability Intelligence Platform

One package. One import. Everything you need to annotate your Flutter app's capabilities and work with the generated manifest — with zero transitive dependencies.

import 'package:scout/scout.dart';

What you get #

1. Annotations for your production code #

Mark screens and service methods so Scout understands your app:

@Capability(
  id: 'mark_attendance',
  label: 'Mark Attendance',
  category: 'Attendance Management',
  description: 'Record attendance for a class session. Requires class ID, date, and records.',
  permissions: ['attendance:write'],
  preconditions: ['authenticated_user', 'selected_class'],
  owner: 'attendance-team',
)
class MarkAttendanceScreen extends StatelessWidget { ... }

@Permission(
  id: 'attendance:write',
  label: 'Write Attendance',
  roles: ['teacher', 'admin'],
)
class AttendanceWritePermission {}

@Workflow(
  id: 'fee_payment_workflow',
  label: 'Pay Fees',
  steps: [
    WorkflowStep(order: 1, capabilityId: 'view_fee_structure'),
    WorkflowStep(order: 2, capabilityId: 'view_fee_dues'),
    WorkflowStep(order: 3, capabilityId: 'pay_fees_online'),
    WorkflowStep(order: 4, capabilityId: 'download_fee_receipt'),
  ],
)
class FeePaymentFlow {}

2. A typed model for reading scout.manifest.json #

Consume the generated manifest in CLI tools, test assertions, custom integrations:

import 'dart:convert';
import 'dart:io';
import 'package:scout/scout.dart';

final json = jsonDecode(File('.scout/manifest.json').readAsStringSync());
final manifest = ScoutManifest.fromJson(json as Map<String, dynamic>);

// What can a teacher do?
final teacherCapabilities = manifest.capabilitiesForRole('teacher');
print(teacherCapabilities.map((c) => c.label).join('\n'));

// Find a specific capability
final cap = manifest.capabilityById('mark_attendance');
print(cap?.aiTool?.description);

// Access routes
for (final route in manifest.routes) {
  print('${route.path} [${route.access}]');
}

Annotations reference #

@Capability fields #

ScoutManifest model #

The ScoutManifest class and its associated types provide a complete typed representation of scout.manifest.json. All classes have fromJson / toJson methods.

Key types #

Convenience methods on ScoutManifest #

// Capabilities visible to a role (filtered by permission→role mapping)
manifest.capabilitiesForRole('teacher')

// Lookup by ID
manifest.capabilityById('mark_attendance')
manifest.routeById('attendance_mark_route')

Installation #

# pubspec.yaml
dependencies:
  scout: ^0.1.0

If you only need the annotations (no manifest model), use scout_annotations instead — it's a strict subset with the same zero-dep guarantee.

The Scout workflow #

# 1. Annotate your screens and services (this package)

# 2. Generate the capability graph
dart run build_runner build

# 3. Inspect the result
scout scan          # analyse + write .scout/manifest.json
scout serve         # MCP + REST server on localhost:4242
scout validate      # CI gate — fails on unlinked routes
scout diff          # detect breaking capability changes

Part of Scout #

The full Scout platform consists of:

License #

MIT