ACP Configuration File

AI Context Protocol configuration file for project-level settings

Type object
File match .acp.config.json
Schema URL https://catalog.lintel.tools/schemas/schemastore/acp-configuration-file/latest.json
Source https://acp-protocol.dev/schemas/v1/config.schema.json

Validate with Lintel

npx @lintel/lintel check
Type: object

AI Context Protocol configuration file format (.acp.config.json)

Properties

version string

ACP specification version

Default: "1.0.0"
pattern=^\d+\.\d+\.\d+
include string[]

Glob patterns for files to include

Default:
[
  "**/*"
]
exclude string[]

Glob patterns for files to exclude

Default:
[
  "node_modules/**",
  ".git/**",
  "dist/**",
  "build/**",
  "coverage/**",
  "**/*.test.*",
  "**/*.spec.*"
]
error_handling object

Error handling configuration

3 nested properties
strictness string

Error handling strictness mode

Default: "permissive"
Values: "permissive" "strict"
max_errors integer

Maximum number of errors before aborting (permissive mode only)

Default: 100
min=1
auto_correct boolean

Whether to automatically fix common errors

Default: false
constraints object

Constraint configuration

3 nested properties
defaults object

Default constraint values

3 nested properties
lock string

Default lock level

Default: "normal"
Values: "frozen" "restricted" "approval-required" "tests-required" "docs-required" "review-required" "normal" "experimental"
style string

Default style guide

behavior string

Default AI behavior

Default: "balanced"
Values: "conservative" "balanced" "aggressive"
track_violations boolean

Enable tracking of constraint violations

Default: false
audit_file string

Violation log file path

Default: ".acp.violations.log"
domains Record<string, object>

Domain patterns for automatic classification

call_graph object

Call graph generation configuration

3 nested properties
include_stdlib boolean

Include standard library calls

Default: false
max_depth integer | null

Maximum call depth (null = unlimited)

Default: null
min=1
exclude_patterns string[]

Patterns to exclude from graph

Default:
[]
limits object

Implementation limits

4 nested properties
max_file_size_mb integer

Maximum source file size in MB

Default: 10
min=1
max_files integer

Maximum files in project

Default: 100000
min=1
max_annotations_per_file integer

Maximum annotations per file

Default: 1000
min=1
max_cache_size_mb integer

Maximum cache file size in MB

Default: 100
min=1
sync Latest Sync.schema | boolean

Sync configuration for AI tool integration (can also be in .acp/acp.sync.json)

annotate object

Annotation generation configuration (RFC-0003)

2 nested properties
provenance object

Provenance tracking settings

4 nested properties
enabled boolean

Enable provenance tracking for generated annotations

Default: true
includeConfidence boolean

Include confidence scores in generated annotations

Default: true
reviewThreshold number

Confidence threshold below which annotations are flagged for review

Default: 0.8
min=0max=1
minConfidence number

Minimum confidence required to emit an annotation

Default: 0.5
min=0max=1
defaults object

Default settings for annotation generation

2 nested properties
markNeedsReview boolean

Mark all generated annotations as needing review

Default: false
overwriteExisting boolean

Overwrite existing annotations when generating

Default: false
bridge object

Documentation bridging configuration (RFC-0006)

7 nested properties
enabled boolean

Enable documentation bridging during indexing

Default: false
precedence string

Precedence when both native docs and ACP exist

Default: "acp-first"
Values: "acp-first" "native-first" "merge"
strictness string

How to handle malformed documentation

Default: "permissive"
Values: "permissive" "strict"
jsdoc object

JSDoc/TSDoc bridging settings

3 nested properties
enabled boolean

Enable JSDoc bridging for JavaScript/TypeScript

Default: true
extractTypes boolean

Extract types from @type, @param {Type}

Default: true
convertTags string[]

JSDoc tags to convert to ACP annotations

Default:
[
  "param",
  "returns",
  "throws",
  "deprecated",
  "example",
  "see"
]
python object

Python docstring bridging settings

4 nested properties
enabled boolean

Enable Python docstring bridging

Default: true
docstringStyle string

Docstring style to parse (auto-detect recommended)

Default: "auto"
Values: "auto" "google" "numpy" "sphinx"
extractTypeHints boolean

Extract type hints from function signatures

Default: true
convertSections string[]

Docstring sections to convert to ACP annotations

Default:
[
  "Args",
  "Parameters",
  "Returns",
  "Raises",
  "Example",
  "Yields"
]
rust object

Rust doc comment bridging settings

2 nested properties
enabled boolean

Enable Rust doc comment bridging

Default: true
convertSections string[]

Rust doc sections to convert

Default:
[
  "Arguments",
  "Returns",
  "Panics",
  "Errors",
  "Examples",
  "Safety"
]
provenance object

Provenance tracking for bridged annotations

2 nested properties
markConverted boolean

Add source: 'converted' to bridged annotations

Default: true
includeSourceFormat boolean

Include sourceFormat field (jsdoc, docstring:google, etc.)

Default: true
documentation object

Documentation and style guide configuration (RFC-0002)

4 nested properties
approvedSources approved_source[]

Trusted documentation sources for this project

styleGuides Record<string, object>

Custom style guide definitions

defaults object

Default documentation settings

2 nested properties
fetchRefs boolean

Default value for @acp:ref-fetch

Default: false
style string

Default style guide for all files

validation object

Reference validation settings

2 nested properties
requireApprovedSources boolean

Only allow refs from approvedSources list

Default: false
warnUnknownStyle boolean

Warn when unknown style guide is referenced

Default: true

Definitions

approved_source object

Approved documentation source definition (RFC-0002)

id string required

Unique identifier for this source (used in @acp:ref)

pattern=^[a-z][a-z0-9-]*$
url string required

Base URL for documentation

format=uri
version string

Version of documentation (semver or custom)

description string

Human-readable description

sections Record<string, string>

Named section shortcuts

fetchable boolean

Whether AI tools should attempt to fetch this source

Default: true
lastVerified string

When this source was last verified accessible

format=date-time
style_guide_definition object

Custom style guide definition (RFC-0002)

extends string

Base style guide to extend

source string

Approved source ID for documentation

url string

Direct URL to style guide documentation

format=uri
description string

Human-readable description

languages string[]

Languages this guide applies to

rules string[]

Style rules (key or key=value format)

filePatterns string[]

Glob patterns for auto-applying this guide