agent-airlock/mkdocs.yml at main · sattyamjjain/agent-airlock · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
site_name: Agent-Airlock
site_description: Security middleware for MCP servers - Intercept, validate, and sandbox AI agent tool calls
site_url: https://agent-airlock.dev
repo_url: https://github.com/attri-ai/agent-airlock
repo_name: attri-ai/agent-airlock

theme:
  name: material
  palette:
    - scheme: default
      primary: deep purple
      accent: amber
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: deep purple
      accent: amber
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
  icon:
    repo: fontawesome/brands/github

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            heading_level: 2

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - admonition
  - pymdownx.details
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Getting Started:
    - Installation: getting-started/installation.md
    - Quick Start: getting-started/quickstart.md
    - Configuration: getting-started/configuration.md
  - User Guide:
    - Core Concepts: guide/concepts.md
    - Validation: guide/validation.md
    - Policy Engine: guide/policy.md
    - PII Masking: guide/sanitization.md
    - E2B Sandbox: guide/sandbox.md
    - FastMCP Integration: guide/mcp.md
  - API Reference:
    - Airlock Decorator: api/airlock.md
    - Configuration: api/config.md
    - Policy: api/policy.md
    - Sanitizer: api/sanitizer.md
    - Sandbox: api/sandbox.md
    - MCP: api/mcp.md
  - Examples:
    - Basic Usage: examples/basic.md
    - Policy Examples: examples/policy.md
    - PII Masking: examples/pii.md
    - Sandbox Execution: examples/sandbox.md
  - Security: SECURITY.md
  - Contributing: CONTRIBUTING.md
  - Changelog: changelog.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/attri-ai/agent-airlock
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/agent-airlock/

copyright: Copyright &copy; 2024-2026 Attri.ai