Skip to content

Configuration

DevKit works with zero configuration. Everything below is optional.

All settings live under strapiDevkit.* (Settings UI → search “DevKit for Strapi”, or edit settings.json).

SettingDefaultWhat it does
strapiDevkit.enabletrueMaster switch for all DevKit features.
strapiDevkit.completion.enabletrueSuggest real Strapi references inside magic-string call sites.
strapiDevkit.diagnostics.enabletrueUnderline invalid references and obsolete Strapi v4 patterns.
strapiDevkit.diagnostics.unknownReferenceSeverity"error"Severity for an unknown/invalid reference — error, warning, information or hint. (The “v4 pattern in a v5 project” warning is unaffected.)
strapiDevkit.hover.enabletrueShow a hover bubble describing what a magic string resolves to, plus service-method signatures.
strapiDevkit.referencesCodeLens.enabletrueShow the “N references (Strapi)” CodeLens on content-types, services, controllers and their methods — counting usages the TypeScript server can’t see.
strapiDevkit.referencesCodeLens.methodstrueAlso show the per-method “N references (Strapi)” lens. Disable to keep only the file-level lens.
strapiDevkit.exclude[]Glob patterns of paths to exclude from project discovery.

If your workspace contains example apps or fixtures you don’t want indexed:

{
"strapiDevkit.exclude": ["examples", "**/fixtures/**"]
}

A discovered project whose path matches any pattern is ignored.

From the Command Palette (Ctrl/Cmd+Shift+P):

  • DevKit for Strapi: Show Detected Projects
  • DevKit for Strapi: Rescan Workspace — re-discover projects and rebuild the index (use after large changes if something looks stale).
  • DevKit for Strapi: Enter License Key — store your Pro licence key (see Pro).
  • DevKit for Strapi: Clear License Key — remove the stored licence key.

In VS Code, Cursor, Windsurf and Antigravity the MCP server is bundled and auto-registered — no config needed.

For other MCP clients (e.g. a standalone agent setup), point the client at the devkit-for-strapi-mcp stdio server and pass your project path:

{
"mcpServers": {
"devkit-for-strapi": {
"command": "devkit-for-strapi-mcp",
"args": ["/absolute/path/to/your/strapi-project"]
}
}
}

The server also accepts the workspace folder via the client’s roots capability (so it just works wherever you open it), and exposes an add_project tool to register a project on demand from an absolute path.

The Pro features (propagated rename, move/extract, safe apply) are unlocked by a licence key:

  • Editor — run DevKit for Strapi: Enter License Key from the Command Palette (stored in the OS keychain, not settings.json).
  • Standalone MCP — set DEVKIT_LICENSE_KEY in the server’s env block.

Validated once on activation, then cached offline. Full steps and the no-licence behaviour: Pro → Activating your licence.