@ai-coders/context 0.5.0 → 0.5.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (114) hide show
  1. package/README.md +103 -360
  2. package/dist/generators/agents/templates/playbookTemplate.d.ts.map +1 -1
  3. package/dist/generators/agents/templates/playbookTemplate.js +5 -1
  4. package/dist/generators/agents/templates/playbookTemplate.js.map +1 -1
  5. package/dist/generators/documentation/templates/apiReferenceTemplate.d.ts.map +1 -1
  6. package/dist/generators/documentation/templates/apiReferenceTemplate.js +3 -1
  7. package/dist/generators/documentation/templates/apiReferenceTemplate.js.map +1 -1
  8. package/dist/generators/documentation/templates/architectureTemplate.d.ts.map +1 -1
  9. package/dist/generators/documentation/templates/architectureTemplate.js +16 -12
  10. package/dist/generators/documentation/templates/architectureTemplate.js.map +1 -1
  11. package/dist/generators/documentation/templates/common.d.ts +5 -0
  12. package/dist/generators/documentation/templates/common.d.ts.map +1 -1
  13. package/dist/generators/documentation/templates/common.js +14 -0
  14. package/dist/generators/documentation/templates/common.js.map +1 -1
  15. package/dist/generators/documentation/templates/dataFlowTemplate.d.ts.map +1 -1
  16. package/dist/generators/documentation/templates/dataFlowTemplate.js +10 -6
  17. package/dist/generators/documentation/templates/dataFlowTemplate.js.map +1 -1
  18. package/dist/generators/documentation/templates/developmentWorkflowTemplate.d.ts.map +1 -1
  19. package/dist/generators/documentation/templates/developmentWorkflowTemplate.js +5 -3
  20. package/dist/generators/documentation/templates/developmentWorkflowTemplate.js.map +1 -1
  21. package/dist/generators/documentation/templates/glossaryTemplate.d.ts.map +1 -1
  22. package/dist/generators/documentation/templates/glossaryTemplate.js +10 -6
  23. package/dist/generators/documentation/templates/glossaryTemplate.js.map +1 -1
  24. package/dist/generators/documentation/templates/migrationTemplate.d.ts.map +1 -1
  25. package/dist/generators/documentation/templates/migrationTemplate.js +3 -1
  26. package/dist/generators/documentation/templates/migrationTemplate.js.map +1 -1
  27. package/dist/generators/documentation/templates/onboardingTemplate.d.ts.map +1 -1
  28. package/dist/generators/documentation/templates/onboardingTemplate.js +3 -1
  29. package/dist/generators/documentation/templates/onboardingTemplate.js.map +1 -1
  30. package/dist/generators/documentation/templates/projectOverviewTemplate.d.ts.map +1 -1
  31. package/dist/generators/documentation/templates/projectOverviewTemplate.js +14 -10
  32. package/dist/generators/documentation/templates/projectOverviewTemplate.js.map +1 -1
  33. package/dist/generators/documentation/templates/securityTemplate.d.ts.map +1 -1
  34. package/dist/generators/documentation/templates/securityTemplate.js +11 -5
  35. package/dist/generators/documentation/templates/securityTemplate.js.map +1 -1
  36. package/dist/generators/documentation/templates/testingTemplate.d.ts.map +1 -1
  37. package/dist/generators/documentation/templates/testingTemplate.js +5 -2
  38. package/dist/generators/documentation/templates/testingTemplate.js.map +1 -1
  39. package/dist/generators/documentation/templates/toolingTemplate.d.ts.map +1 -1
  40. package/dist/generators/documentation/templates/toolingTemplate.js +11 -8
  41. package/dist/generators/documentation/templates/toolingTemplate.js.map +1 -1
  42. package/dist/generators/documentation/templates/troubleshootingTemplate.d.ts.map +1 -1
  43. package/dist/generators/documentation/templates/troubleshootingTemplate.js +3 -1
  44. package/dist/generators/documentation/templates/troubleshootingTemplate.js.map +1 -1
  45. package/dist/generators/plans/templates/planTemplate.d.ts.map +1 -1
  46. package/dist/generators/plans/templates/planTemplate.js +5 -3
  47. package/dist/generators/plans/templates/planTemplate.js.map +1 -1
  48. package/dist/index.d.ts.map +1 -1
  49. package/dist/index.js +235 -39
  50. package/dist/index.js.map +1 -1
  51. package/dist/services/ai/agents/documentationAgent.d.ts.map +1 -1
  52. package/dist/services/ai/agents/documentationAgent.js +3 -29
  53. package/dist/services/ai/agents/documentationAgent.js.map +1 -1
  54. package/dist/services/ai/agents/planAgent.d.ts.map +1 -1
  55. package/dist/services/ai/agents/planAgent.js +6 -53
  56. package/dist/services/ai/agents/planAgent.js.map +1 -1
  57. package/dist/services/ai/agents/playbookAgent.d.ts.map +1 -1
  58. package/dist/services/ai/agents/playbookAgent.js +3 -24
  59. package/dist/services/ai/agents/playbookAgent.js.map +1 -1
  60. package/dist/services/ai/prompts/index.d.ts +2 -0
  61. package/dist/services/ai/prompts/index.d.ts.map +1 -0
  62. package/dist/services/ai/prompts/index.js +12 -0
  63. package/dist/services/ai/prompts/index.js.map +1 -0
  64. package/dist/services/ai/prompts/sharedPrompts.d.ts +33 -0
  65. package/dist/services/ai/prompts/sharedPrompts.d.ts.map +1 -0
  66. package/dist/services/ai/prompts/sharedPrompts.js +136 -0
  67. package/dist/services/ai/prompts/sharedPrompts.js.map +1 -0
  68. package/dist/services/ai/schemas.d.ts +1 -1
  69. package/dist/services/ai/toolRegistry.d.ts +27 -0
  70. package/dist/services/ai/toolRegistry.d.ts.map +1 -0
  71. package/dist/services/ai/toolRegistry.js +126 -0
  72. package/dist/services/ai/toolRegistry.js.map +1 -0
  73. package/dist/services/ai/tools/fillScaffoldingTool.d.ts +75 -5
  74. package/dist/services/ai/tools/fillScaffoldingTool.d.ts.map +1 -1
  75. package/dist/services/ai/tools/fillScaffoldingTool.js +247 -43
  76. package/dist/services/ai/tools/fillScaffoldingTool.js.map +1 -1
  77. package/dist/services/ai/tools/index.d.ts +2 -2
  78. package/dist/services/ai/tools/index.d.ts.map +1 -1
  79. package/dist/services/ai/tools/index.js +9 -3
  80. package/dist/services/ai/tools/index.js.map +1 -1
  81. package/dist/services/ai/tools/initializeContextTool.d.ts +1 -1
  82. package/dist/services/fill/fillService.d.ts.map +1 -1
  83. package/dist/services/fill/fillService.js +7 -2
  84. package/dist/services/fill/fillService.js.map +1 -1
  85. package/dist/services/mcp/mcpServer.d.ts.map +1 -1
  86. package/dist/services/mcp/mcpServer.js +60 -20
  87. package/dist/services/mcp/mcpServer.js.map +1 -1
  88. package/dist/services/state/index.d.ts +2 -0
  89. package/dist/services/state/index.d.ts.map +1 -0
  90. package/dist/services/state/index.js +6 -0
  91. package/dist/services/state/index.js.map +1 -0
  92. package/dist/services/state/stateDetector.d.ts +53 -0
  93. package/dist/services/state/stateDetector.d.ts.map +1 -0
  94. package/dist/services/state/stateDetector.js +189 -0
  95. package/dist/services/state/stateDetector.js.map +1 -0
  96. package/dist/services/update/index.d.ts +2 -0
  97. package/dist/services/update/index.d.ts.map +1 -0
  98. package/dist/services/update/index.js +6 -0
  99. package/dist/services/update/index.js.map +1 -0
  100. package/dist/services/update/updateService.d.ts +64 -0
  101. package/dist/services/update/updateService.d.ts.map +1 -0
  102. package/dist/services/update/updateService.js +295 -0
  103. package/dist/services/update/updateService.js.map +1 -0
  104. package/dist/types.d.ts +0 -5
  105. package/dist/types.d.ts.map +1 -1
  106. package/dist/utils/frontMatter.d.ts +55 -0
  107. package/dist/utils/frontMatter.d.ts.map +1 -0
  108. package/dist/utils/frontMatter.js +173 -0
  109. package/dist/utils/frontMatter.js.map +1 -0
  110. package/dist/utils/i18n.d.ts +14 -0
  111. package/dist/utils/i18n.d.ts.map +1 -1
  112. package/dist/utils/i18n.js +28 -0
  113. package/dist/utils/i18n.js.map +1 -1
  114. package/package.json +1 -1
package/README.md CHANGED
@@ -4,433 +4,176 @@
4
4
  [![CI](https://github.com/vinilana/ai-coders-context/actions/workflows/ci.yml/badge.svg)](https://github.com/vinilana/ai-coders-context/actions/workflows/ci.yml)
5
5
  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
6
6
 
7
- <img width="663" height="192" alt="image" src="https://github.com/user-attachments/assets/4b07f61d-6800-420a-ae91-6e952cbc790d" />
8
7
 
8
+ Context engineering for AI should be stupidly simple.
9
9
 
10
- A lightweight CLI that scaffolds living documentation and AI-agent playbooks for any repository—no LLMs or API keys required. The generated structure gives teams a consistent starting point for knowledge sharing while keeping everything under version control.
11
-
12
- ## ⚙️ Requirements
13
-
14
- - Node.js 20+ (we currently test on 20, 22, 23, and 24)
15
-
16
- ## ✨ What You Get
17
-
18
- - 📚 `docs/` folder with a documentation index plus ready-to-edit guides (overview, architecture, workflow, testing)
19
- - 🤖 `agents/` folder containing playbooks for common engineering agents and a handy index
20
- - 🔁 Repeatable scaffolding that you can re-run as the project evolves
21
- - 🧭 Repository-aware templates that highlight top-level directories for quick orientation
22
- - 🧠 AI-ready templates that assistants can update using the `fill` command
23
- - 🌐 **Multi-provider support** for OpenAI, Anthropic, Google, and OpenRouter
24
- - ⚡ **Semantic context mode** using Tree-sitter for token-efficient LLM calls
25
- - 📊 **Real-time progress** showing agent activity and tool usage
26
- - 🔌 **MCP Server** for seamless Claude Code integration
27
- - 🔗 **Passthrough mode** for external AI agents via stdin/stdout JSON
28
-
29
- ## 📦 Installation
30
-
31
- Use `npx` to run the CLI without installing globally:
32
-
33
- ```bash
34
- npx @ai-coders/context
35
- ```
36
-
37
- Or add it to your dev dependencies:
38
-
39
- ```bash
40
- npm install --save-dev @ai-coders/context
41
- ```
42
-
43
- ## 🚀 Quick Start
10
+ ## Usage
44
11
 
45
12
  ```bash
46
- # Launch the interactive wizard
47
13
  npx @ai-coders/context
48
-
49
-
50
- # Scaffold docs and agents into ./.context
51
- npx @ai-coders/context init ./my-repo
52
-
53
- # Only generate docs
54
- npx @ai-coders/context init ./my-repo docs
55
-
56
- # Only generate agent playbooks, with a custom output directory
57
- npx @ai-coders/context init ./my-repo agents --output ./knowledge-base
58
-
59
- # Fill docs and agents with the repo context (preview the first 3 updates)
60
- npx @ai-coders/context fill ./my-repo --output ./.context --limit 3
61
-
62
- # Use a specific provider (OpenAI, Anthropic, Google, or OpenRouter)
63
- npx @ai-coders/context fill ./my-repo --provider anthropic --model claude-sonnet-4-20250514
64
-
65
- # Disable semantic mode for more thorough tool-based exploration
66
- npx @ai-coders/context fill ./my-repo --no-semantic
67
-
68
- # Specify languages for semantic analysis
69
- npx @ai-coders/context fill ./my-repo --languages typescript,python,go
70
-
71
- # Draft a collaboration plan seeded with agent and doc touchpoints
72
- npx @ai-coders/context plan release-readiness --output ./.context
73
-
74
- # Let the LLM enrich an existing plan with the latest context
75
- npx @ai-coders/context plan release-readiness --output ./.context --fill --dry-run
76
- ```
77
-
78
- > ℹ️ The CLI pings npm for fresh releases at startup. Set `AI_CONTEXT_DISABLE_UPDATE_CHECK=true` to skip the check.
79
-
80
- After running the command, inspect the generated structure:
81
-
82
- ```
83
- .context/
84
- ├── agents/
85
- │ ├── README.md
86
- │ ├── code-reviewer.md
87
- │ └── ...
88
- └── docs/
89
- ├── README.md
90
- ├── architecture.md
91
- └── ...
92
- ```
93
-
94
- Customize the Markdown files to reflect your project's specifics and commit them alongside the code.
95
-
96
- ## 🌐 Multi-Provider Support
97
-
98
- The `fill` and `plan` commands support multiple LLM providers:
99
-
100
- | Provider | Models | Environment Variable |
101
- |----------|--------|---------------------|
102
- | OpenRouter | `x-ai/grok-4-fast`, `anthropic/claude-sonnet-4`, etc. | `OPENROUTER_API_KEY` |
103
- | OpenAI | `gpt-4o`, `gpt-4-turbo`, etc. | `OPENAI_API_KEY` |
104
- | Anthropic | `claude-sonnet-4-20250514`, `claude-opus-4-20250514`, etc. | `ANTHROPIC_API_KEY` |
105
- | Google | `gemini-2.0-flash`, `gemini-1.5-pro`, etc. | `GOOGLE_API_KEY` |
106
-
107
- The CLI auto-detects available API keys from environment variables. Override with `--provider` and `--model`:
108
-
109
- ```bash
110
- # Use Anthropic's Claude
111
- ANTHROPIC_API_KEY=sk-... npx @ai-coders/context fill . --provider anthropic
112
-
113
- # Use OpenAI's GPT-4
114
- OPENAI_API_KEY=sk-... npx @ai-coders/context fill . --provider openai --model gpt-4o
115
14
  ```
116
15
 
117
- ## Semantic Context Mode
16
+ That's it. The wizard detects what needs to be done.
118
17
 
119
- By default, the `fill` command uses **semantic context mode** which pre-computes codebase analysis using Tree-sitter before calling the LLM. This is:
18
+ ## What it does
120
19
 
121
- - **Faster**: Single LLM call instead of multi-step tool exploration
122
- - **Token-efficient**: Pre-computed context instead of back-and-forth tool calls
123
- - **Consistent**: Same analysis applied to all files
20
+ 1. **Creates documentation** Structured docs from your codebase
21
+ 2. **Generates playbooks** Guides for AI agents (Claude, GPT, etc.)
22
+ 3. **Keeps it updated** Detects code changes and suggests updates
124
23
 
125
- To use the more thorough tool-based exploration (where the LLM explores the codebase step by step), use `--no-semantic`:
24
+ ## For automation
126
25
 
127
26
  ```bash
128
- npx @ai-coders/context fill . --no-semantic
27
+ npx @ai-coders/context init . # Create structure
28
+ npx @ai-coders/context fill . # Fill with AI
29
+ npx @ai-coders/context update # Update outdated docs
30
+ npx @ai-coders/context plan name # Create work plan
129
31
  ```
130
32
 
131
- ### Language Selection
33
+ ## Requirements
132
34
 
133
- Specify which programming languages to analyze for semantic context:
35
+ - Node.js 20+
36
+ - API key from a supported provider (for AI features)
134
37
 
135
- ```bash
136
- # Analyze only TypeScript and Python
137
- npx @ai-coders/context fill . --languages typescript,python
138
-
139
- # Default languages: typescript, javascript, python, go
140
- ```
38
+ ## Supported Providers
141
39
 
142
- Supported languages: `typescript`, `javascript`, `python`, `go`, `rust`, `java`, `cpp`, `c_sharp`, `ruby`, `php`
40
+ | Provider | Environment Variable |
41
+ |----------|---------------------|
42
+ | OpenRouter | `OPENROUTER_API_KEY` |
43
+ | OpenAI | `OPENAI_API_KEY` |
44
+ | Anthropic | `ANTHROPIC_API_KEY` |
45
+ | Google | `GOOGLE_API_KEY` |
143
46
 
144
- ### LSP Enhancement (Optional)
47
+ ## MCP Server Setup
145
48
 
146
- For deeper semantic analysis, the tool supports optional **LSP (Language Server Protocol)** integration. While Tree-sitter handles ~90% of the analysis with fast syntactic parsing, LSP provides additional semantic information when enabled:
49
+ This package includes an MCP (Model Context Protocol) server that provides AI coding assistants with powerful tools to analyze and document your codebase.
147
50
 
148
- | Feature | Tree-sitter | LSP |
149
- |---------|-------------|-----|
150
- | Symbol extraction | ✅ | - |
151
- | Import/export analysis | ✅ | - |
152
- | Type inference | - | ✅ |
153
- | Interface implementations | - | ✅ |
154
- | Cross-file references | - | ✅ |
155
- | Definition resolution | - | ✅ |
51
+ ### Claude Code (CLI)
156
52
 
157
- **Usage:**
53
+ Add the MCP server using the Claude CLI:
158
54
 
159
55
  ```bash
160
- # Enable LSP for fill command (disabled by default)
161
- npx @ai-coders/context fill ./my-repo --lsp
162
-
163
- # LSP is enabled by default for plan fill
164
- npx @ai-coders/context plan my-plan --fill
165
-
166
- # Disable LSP for plan fill
167
- npx @ai-coders/context plan my-plan --fill --no-lsp
56
+ claude mcp add ai-context -- npx @ai-coders/context mcp
168
57
  ```
169
58
 
170
- **Supported Language Servers:**
171
- - TypeScript/JavaScript: `typescript-language-server`
172
- - Python: `pylsp`
173
-
174
- **Graceful Degradation:** If a language server is not installed, the analysis continues without LSP enhancement—no errors, no interruption.
175
-
176
- ## 🧠 Guided Updates for AI Assistants
177
-
178
- Need help filling in the scaffold? Use [`prompts/update_scaffold_prompt.md`](./prompts/update_scaffold_prompt.md) as the canonical instruction set for any LLM or CLI agent. Share that prompt verbatim with your assistant to keep updates consistent across teams.
59
+ Or configure manually in `~/.claude.json`:
179
60
 
180
- ### Available Doc Guides & Agent Types
181
-
182
- The scaffold includes the following guides and playbooks out of the box:
183
-
184
- - Docs: `project-overview`, `architecture`, `development-workflow`, `testing-strategy`, `glossary`, `data-flow`, `security`, `tooling`
185
- - Agents: `code-reviewer`, `bug-fixer`, `feature-developer`, `refactoring-specialist`, `test-writer`, `documentation-writer`, `performance-optimizer`, `security-auditor`, `backend-specialist`, `frontend-specialist`, `architect-specialist`
186
-
187
- ## 🛠 Commands
188
-
189
- ### `init`
190
- Scaffold documentation and/or agent playbooks.
191
-
192
- ```
193
- Usage: ai-context init <repo-path> [type]
194
-
195
- Arguments:
196
- repo-path Path to the repository you want to scan
197
- type "docs", "agents", or "both" (default)
198
-
199
- Options:
200
- -o, --output <dir> Output directory (default: ./.context)
201
- --exclude <patterns...> Glob patterns to skip during the scan
202
- --include <patterns...> Glob patterns to explicitly include
203
- --no-semantic Disable semantic code analysis
204
- -v, --verbose Print detailed progress information
205
- -h, --help Display help for command
206
- ```
207
-
208
- ### `fill`
209
- Use an LLM to refresh scaffolded docs and agent playbooks automatically.
210
-
211
- ```
212
- Usage: ai-context fill <repo-path>
213
-
214
- Options:
215
- -o, --output <dir> Scaffold directory containing docs/ and agents/ (default: ./.context)
216
- -k, --api-key <key> API key for the selected LLM provider
217
- -m, --model <model> LLM model to use (default: x-ai/grok-4-fast)
218
- -p, --provider <name> Provider: openrouter, openai, anthropic, or google
219
- --base-url <url> Custom base URL for provider APIs
220
- --prompt <file> Instruction prompt to follow (optional; uses bundled instructions when omitted)
221
- --limit <number> Maximum number of files to update in one run
222
- --no-semantic Disable semantic context mode (use tool-based exploration)
223
- --languages <langs> Programming languages to analyze (e.g., typescript,python,go)
224
- --exclude <patterns...> Glob patterns to exclude from repository analysis
225
- --include <patterns...> Glob patterns to include during analysis
226
- -v, --verbose Print detailed progress information
227
- -h, --help Display help for command
228
- ```
229
-
230
- Under the hood, the command uses specialized agents (DocumentationAgent, PlaybookAgent) that analyze your codebase and generate context-aware documentation. Real-time progress is displayed showing which agent is working and what tools are being used.
231
-
232
- ### `plan`
233
- Create a collaboration plan that links documentation guides and agent playbooks, or fill an existing plan with LLM assistance.
234
-
235
- ```
236
- Usage: ai-context plan <plan-name>
237
-
238
- Options:
239
- -o, --output <dir> Scaffold directory containing docs/ and agents/ (default: ./.context)
240
- --title <title> Custom title for the plan document
241
- --summary <text> Seed the plan with a short summary or goal statement
242
- -f, --force Overwrite the plan if it already exists (scaffold mode)
243
- --fill Use an LLM to fill or update the plan instead of scaffolding
244
- -r, --repo <path> Repository root to summarize for additional context (fill mode)
245
- -k, --api-key <key> API key for the selected LLM provider (fill mode)
246
- -m, --model <model> LLM model to use (default: x-ai/grok-4-fast)
247
- -p, --provider <name> Provider: openrouter, openai, anthropic, or google
248
- --base-url <url> Custom base URL for provider APIs
249
- --prompt <file> Instruction prompt to follow (optional; uses bundled instructions when omitted)
250
- --dry-run Preview changes without writing files
251
- --no-semantic Disable semantic context mode
252
- --include <patterns...> Glob patterns to include during repository analysis
253
- --exclude <patterns...> Glob patterns to exclude from repository analysis
254
- -v, --verbose Print detailed progress information
255
- -h, --help Display help for command
61
+ ```json
62
+ {
63
+ "mcpServers": {
64
+ "ai-context": {
65
+ "command": "npx",
66
+ "args": ["@ai-coders/context", "mcp"]
67
+ }
68
+ }
69
+ }
256
70
  ```
257
71
 
258
- In scaffold mode the command creates `.context/plans/<plan-name>.md`, keeps a `plans/README.md` index, and reminds contributors to consult the agent handbook before delegating work to an AI assistant. In fill mode it will scaffold the plan automatically if it does not exist, then read the plan plus its referenced docs and agent playbooks, send that context to the LLM, and either preview or write the updated Markdown.
72
+ ### Claude Desktop
259
73
 
260
- 💡 Tip: run `npx @ai-coders/context` with no arguments to enter an interactive mode that guides you through scaffold and LLM-fill options.
74
+ Add to your Claude Desktop config (`~/Library/Application Support/Claude/claude_desktop_config.json` on macOS or `%APPDATA%\Claude\claude_desktop_config.json` on Windows):
261
75
 
262
- Prefer driving the update elsewhere? Just grab [`prompts/update_scaffold_prompt.md`](./prompts/update_scaffold_prompt.md) and run it in your favorite playground or agent host. When you're ready to automate, drop your API key in `.env` (for example `OPENROUTER_API_KEY` and `OPENROUTER_MODEL`) and let `fill` handle the edits inline.
263
-
264
- ### `mcp`
265
- Start an MCP (Model Context Protocol) server for Claude Code integration. This exposes code analysis tools and semantic context as MCP resources.
266
-
267
- ```
268
- Usage: ai-context mcp
269
-
270
- Options:
271
- -r, --repo-path <path> Default repository path for tools
272
- -v, --verbose Enable verbose logging to stderr
273
- -h, --help Display help for command
76
+ ```json
77
+ {
78
+ "mcpServers": {
79
+ "ai-context": {
80
+ "command": "npx",
81
+ "args": ["@ai-coders/context", "mcp"]
82
+ }
83
+ }
84
+ }
274
85
  ```
275
86
 
276
- **Available MCP Tools:**
277
- - `readFile` - Read file contents from the filesystem
278
- - `listFiles` - List files matching a glob pattern
279
- - `analyzeSymbols` - Extract code symbols (classes, functions, interfaces) using Tree-sitter
280
- - `getFileStructure` - Get the directory structure of a repository
281
- - `searchCode` - Search for code patterns using regex
282
- - `buildSemanticContext` - Build optimized semantic context for LLM prompts
283
- - `checkScaffolding` - Check if `.context` scaffolding exists (returns granular status for docs, agents, plans)
284
- - `initializeContext` - Initialize `.context` scaffolding (create template files)
285
- - `fillScaffolding` - Analyze codebase and generate content for each template file (AI agent writes the content)
286
- - `scaffoldPlan` - Create a plan template in `.context/plans/`
287
-
288
- **Available MCP Resources:**
289
- - `context://codebase/{contextType}` - Semantic context (documentation, playbook, plan, compact)
290
- - `file://{path}` - Read file contents
291
-
292
- ### `serve`
293
- Start a passthrough server for external AI agents. Accepts JSON commands via stdin and responds via stdout.
87
+ ### Cursor AI
294
88
 
295
- ```
296
- Usage: ai-context serve
89
+ Create `.cursor/mcp.json` in your project root:
297
90
 
298
- Options:
299
- -r, --repo-path <path> Default repository path for tools
300
- -f, --format <format> Output format: json or jsonl (default: jsonl)
301
- -v, --verbose Enable verbose logging to stderr
302
- -h, --help Display help for command
91
+ ```json
92
+ {
93
+ "mcpServers": {
94
+ "ai-context": {
95
+ "command": "npx",
96
+ "args": ["@ai-coders/context", "mcp"]
97
+ }
98
+ }
99
+ }
303
100
  ```
304
101
 
305
- **Available Methods:**
306
- - `capabilities` - List server capabilities
307
- - `tool.list` - List available tools
308
- - `tool.call` - Execute a tool
309
- - `context.build` - Build semantic context
310
- - `agent.run` - Run an agent (requires LLM config)
311
-
312
- ## 🔌 Claude Code Integration (MCP)
102
+ ### Windsurf
313
103
 
314
- The easiest way to use this package with Claude Code is through the MCP server. Add the following to your Claude Code settings:
104
+ Add to your Windsurf MCP config (`~/.codeium/windsurf/mcp_config.json`):
315
105
 
316
- **~/.claude/settings.json:**
317
106
  ```json
318
107
  {
319
108
  "mcpServers": {
320
109
  "ai-context": {
321
110
  "command": "npx",
322
- "args": ["@ai-coders/context", "mcp", "-r", "/path/to/your/repo"]
111
+ "args": ["@ai-coders/context", "mcp"]
323
112
  }
324
113
  }
325
114
  }
326
115
  ```
327
116
 
328
- Once configured, Claude Code will have access to all code analysis tools:
329
-
330
- ```
331
- # Claude Code can now use these tools:
332
- - readFile: Read any file in your repository
333
- - listFiles: Find files by glob patterns
334
- - analyzeSymbols: Extract code structure with Tree-sitter
335
- - searchCode: Search for patterns across the codebase
336
- - buildSemanticContext: Get optimized context for any task
337
- - checkScaffolding: Check if .context scaffolding exists
338
- - initializeContext: Create scaffolding templates
339
- - fillScaffolding: Generate content for templates
340
- - scaffoldPlan: Create plan templates
341
- ```
342
-
343
- ### Example MCP Usage in Claude Code
344
-
345
- When working with Claude Code, you can ask it to:
117
+ ### Zed Editor
346
118
 
347
- - "Use the ai-context tools to analyze the authentication module"
348
- - "Build a semantic context for the src/services directory"
349
- - "List all TypeScript files in the project and analyze their exports"
350
-
351
- ## 🔗 External AI Agent Integration (Passthrough)
352
-
353
- For AI agents that don't support MCP, use the passthrough server with JSON communication:
354
-
355
- ```bash
356
- # Start the server
357
- npx @ai-coders/context serve -r ./my-project
119
+ Add to your Zed settings (`~/.config/zed/settings.json`):
358
120
 
359
- # Send commands via stdin
360
- echo '{"id":"1","method":"capabilities"}' | npx @ai-coders/context serve
121
+ ```json
122
+ {
123
+ "context_servers": {
124
+ "ai-context": {
125
+ "command": {
126
+ "path": "npx",
127
+ "args": ["@ai-coders/context", "mcp"]
128
+ }
129
+ }
130
+ }
131
+ }
361
132
  ```
362
133
 
363
- **Example: List files**
364
- ```bash
365
- echo '{"id":"1","method":"tool.call","params":{"tool":"listFiles","args":{"pattern":"**/*.ts"}}}' \
366
- | npx @ai-coders/context serve -r ./my-project
367
- ```
134
+ ### Cline (VS Code Extension)
368
135
 
369
- **Example: Build semantic context**
370
- ```bash
371
- echo '{"id":"1","method":"context.build","params":{"repoPath":"./","contextType":"documentation"}}' \
372
- | npx @ai-coders/context serve
373
- ```
136
+ Configure in Cline settings (VS Code → Settings → Cline → MCP Servers):
374
137
 
375
- **Response format:**
376
138
  ```json
377
139
  {
378
- "id": "1",
379
- "success": true,
380
- "result": { /* tool output */ }
140
+ "mcpServers": {
141
+ "ai-context": {
142
+ "command": "npx",
143
+ "args": ["@ai-coders/context", "mcp"]
144
+ }
145
+ }
381
146
  }
382
147
  ```
383
148
 
384
- **Notifications (streamed during execution):**
385
- ```json
386
- {"type": "progress", "data": {"step": 1, "message": "Analyzing..."}}
387
- {"type": "tool_call", "data": {"toolName": "readFile", "args": {"filePath": "..."}}}
388
- {"type": "tool_result", "data": {"toolName": "readFile", "success": true}}
389
- ```
149
+ ### Codex CLI
390
150
 
391
- ## 🔧 Environment Variables
151
+ Add to your Codex CLI config (`~/.codex/config.toml`):
392
152
 
393
- ```bash
394
- # Provider selection (auto-detected from available keys)
395
- AI_CONTEXT_PROVIDER=openrouter|openai|anthropic|google
396
-
397
- # API Keys (at least one required for fill/plan --fill)
398
- OPENROUTER_API_KEY=...
399
- OPENAI_API_KEY=...
400
- ANTHROPIC_API_KEY=...
401
- GOOGLE_API_KEY=...
402
-
403
- # Optional model override per provider
404
- OPENROUTER_MODEL=x-ai/grok-4-fast
405
- OPENAI_MODEL=gpt-4o
406
- ANTHROPIC_MODEL=claude-sonnet-4-20250514
407
- GOOGLE_MODEL=gemini-2.0-flash
408
-
409
- # CLI settings
410
- AI_CONTEXT_LANG=en|pt-BR
411
- AI_CONTEXT_DISABLE_UPDATE_CHECK=true
153
+ ```toml
154
+ [mcp_servers.ai-context]
155
+ command = "npx"
156
+ args = ["--yes", "@ai-coders/context@latest", "mcp"]
412
157
  ```
413
158
 
414
- ## 🧰 Local Development
159
+ ### Available MCP Tools
415
160
 
416
- ```bash
417
- git clone https://github.com/vinilana/ai-coders-context.git
418
- cd ai-coders-context
419
- npm install
420
- npm run build
421
- npm run test
422
- ```
161
+ Once configured, your AI assistant will have access to:
423
162
 
424
- During development you can run the CLI directly against TypeScript sources:
425
-
426
- ```bash
427
- npm run dev -- ./path/to/repo
428
- ```
163
+ | Tool | Description |
164
+ |------|-------------|
165
+ | `buildSemanticContext` | Build optimized context for LLM prompts |
166
+ | `initializeContext` | Create `.context` scaffolding |
167
+ | `fillScaffolding` | Generate documentation content |
168
+ | `analyzeSymbols` | Analyze code symbols (classes, functions, etc.) |
169
+ | `searchCode` | Search for patterns across files |
170
+ | `getFileStructure` | Get repository directory structure |
171
+ | `scaffoldPlan` | Create work plans |
429
172
 
430
- ## 🤝 Contributing
173
+ ## Contributing
431
174
 
432
- See [`AGENTS.md`](./AGENTS.md) for contributor guidelines, coding standards, and release tips. Pull requests are welcome!
175
+ - [Development Guide](./AGENTS.md) Development guidelines
433
176
 
434
- ## 📄 License
177
+ ## License
435
178
 
436
179
  MIT © Vinícius Lana
@@ -1 +1 @@
1
- {"version":3,"file":"playbookTemplate.d.ts","sourceRoot":"","sources":["../../../../src/generators/agents/templates/playbookTemplate.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE1C,OAAO,EAAE,aAAa,EAAE,aAAa,EAAwB,MAAM,SAAS,CAAC;AAC7E,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAgH7D,wBAAgB,mBAAmB,CACjC,SAAS,EAAE,SAAS,EACpB,mBAAmB,EAAE,MAAM,EAAE,EAC7B,WAAW,EAAE,aAAa,EAAE,EAC5B,SAAS,CAAC,EAAE,eAAe,EAC3B,eAAe,CAAC,EAAE,aAAa,EAAE,EACjC,QAAQ,GAAE,MAAsB,GAC/B,MAAM,CAoDR"}
1
+ {"version":3,"file":"playbookTemplate.d.ts","sourceRoot":"","sources":["../../../../src/generators/agents/templates/playbookTemplate.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE1C,OAAO,EAAE,aAAa,EAAE,aAAa,EAAwB,MAAM,SAAS,CAAC;AAC7E,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAiH7D,wBAAgB,mBAAmB,CACjC,SAAS,EAAE,SAAS,EACpB,mBAAmB,EAAE,MAAM,EAAE,EAC7B,WAAW,EAAE,aAAa,EAAE,EAC5B,SAAS,CAAC,EAAE,eAAe,EAC3B,eAAe,CAAC,EAAE,aAAa,EAAE,EACjC,QAAQ,GAAE,MAAsB,GAC/B,MAAM,CAwDR"}
@@ -36,6 +36,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
36
36
  exports.renderAgentPlaybook = renderAgentPlaybook;
37
37
  const agentConfig_1 = require("../agentConfig");
38
38
  const directoryTemplateHelpers_1 = require("../../shared/directoryTemplateHelpers");
39
+ const common_1 = require("../../documentation/templates/common");
39
40
  const path = __importStar(require("path"));
40
41
  /**
41
42
  * Format a symbol as a markdown link with line number
@@ -143,7 +144,7 @@ function renderAgentPlaybook(agentType, topLevelDirectories, touchpoints, semant
143
144
  const keySymbolsSection = renderKeySymbols(relevantSymbols, repoRoot);
144
145
  const keyFilesSection = renderKeyFiles(semantics, repoRoot);
145
146
  const architectureSection = renderArchitectureLayers(semantics, repoRoot);
146
- return `# ${title} Agent Playbook
147
+ const content = `# ${title} Agent Playbook
147
148
 
148
149
  ## Mission
149
150
  Describe how the ${title.toLowerCase()} agent supports the team and when to engage it.
@@ -173,14 +174,17 @@ ${keySymbolsSection}
173
174
  ${touchpointList}
174
175
 
175
176
  ## Collaboration Checklist
177
+
176
178
  1. Confirm assumptions with issue reporters or maintainers.
177
179
  2. Review open pull requests affecting this area.
178
180
  3. Update the relevant doc section listed above.
179
181
  4. Capture learnings back in [docs/README.md](../docs/README.md).
180
182
 
181
183
  ## Hand-off Notes
184
+
182
185
  Summarize outcomes, remaining risks, and suggested follow-up actions after the agent completes its work.
183
186
  `;
187
+ return (0, common_1.wrapWithFrontMatter)(content);
184
188
  }
185
189
  function formatTitle(agentType) {
186
190
  return agentType
@@ -1 +1 @@
1
- {"version":3,"file":"playbookTemplate.js","sourceRoot":"","sources":["../../../../src/generators/agents/templates/playbookTemplate.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoHA,kDA2DC;AA/KD,gDAA8E;AAE9E,oFAA4E;AAG5E,2CAA6B;AAE7B;;;GAGG;AACH,SAAS,gBAAgB,CAAC,MAAqB,EAAE,QAAgB;IAC/D,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;IACrD,OAAO,MAAM,MAAM,CAAC,IAAI,OAAO,OAAO,KAAK,MAAM,CAAC,IAAI,GAAG,CAAC;AAC5D,CAAC;AAED;;;GAGG;AACH,SAAS,cAAc,CAAC,QAAgB,EAAE,QAAgB;IACxD,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IAClD,OAAO,MAAM,OAAO,OAAO,OAAO,GAAG,CAAC;AACxC,CAAC;AAED,SAAS,gBAAgB,CAAC,OAAoC,EAAE,QAAgB;IAC9E,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACrC,OAAO,mCAAmC,CAAC;IAC7C,CAAC;IAED,OAAO,OAAO;SACX,GAAG,CAAC,CAAC,CAAC,EAAE;QACP,MAAM,GAAG,GAAG,gBAAgB,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;QAC1C,OAAO,KAAK,GAAG,KAAK,CAAC,CAAC,IAAI,GAAG,CAAC;IAChC,CAAC,CAAC;SACD,IAAI,CAAC,IAAI,CAAC,CAAC;AAChB,CAAC;AAED,SAAS,wBAAwB,CAAC,SAAsC,EAAE,QAAgB;IACxF,IAAI,CAAC,SAAS,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;QACxD,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,MAAM,KAAK,GAAG,CAAC,yBAAyB,EAAE,EAAE,CAAC,CAAC;IAC9C,KAAK,MAAM,KAAK,IAAI,SAAS,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC;QAClD,MAAM,WAAW,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC;QACzC,MAAM,IAAI,GAAG,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC/D,KAAK,CAAC,IAAI,CAAC,OAAO,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;QAChC,KAAK,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC;QACnC,KAAK,CAAC,IAAI,CAAC,sBAAsB,IAAI,EAAE,CAAC,CAAC;QACzC,KAAK,CAAC,IAAI,CAAC,kBAAkB,WAAW,QAAQ,CAAC,CAAC;QAElD,sCAAsC;QACtC,MAAM,UAAU,GAAG,KAAK,CAAC,OAAO;aAC7B,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;QAE3B,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC1B,MAAM,UAAU,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE;gBACpC,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;gBACzD,OAAO,MAAM,CAAC,CAAC,IAAI,OAAO,OAAO,KAAK,CAAC,CAAC,QAAQ,CAAC,IAAI,GAAG,CAAC;YAC3D,CAAC,CAAC,CAAC;YACH,KAAK,CAAC,IAAI,CAAC,sBAAsB,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC5D,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC;IACD,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC;AAED,SAAS,cAAc,CAAC,SAAsC,EAAE,QAAgB;IAC9E,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,OAAO,4BAA4B,CAAC;IACtC,CAAC;IAED,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,eAAe;IACf,IAAI,SAAS,CAAC,YAAY,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAClD,KAAK,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;QAChC,KAAK,MAAM,EAAE,IAAI,SAAS,CAAC,YAAY,CAAC,WAAW,EAAE,CAAC;YACpD,KAAK,CAAC,IAAI,CAAC,KAAK,cAAc,CAAC,EAAE,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAC;QAClD,CAAC;IACH,CAAC;IAED,oBAAoB;IACpB,IAAI,SAAS,CAAC,YAAY,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC/C,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC;YAAE,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACrC,KAAK,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAC;QAC3C,KAAK,MAAM,OAAO,IAAI,SAAS,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC;YACtD,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;gBAC5C,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;gBAClD,OAAO,MAAM,GAAG,CAAC,MAAM,OAAO,OAAO,GAAG,CAAC;YAC3C,CAAC,CAAC,CAAC;YACH,KAAK,CAAC,IAAI,CAAC,KAAK,OAAO,CAAC,IAAI,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC3D,CAAC;IACH,CAAC;IAED,gDAAgD;IAChD,MAAM,QAAQ,GAAG,SAAS,CAAC,OAAO,CAAC,OAAO;SACvC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,CAAC;IAEzD,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACxB,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC;YAAE,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACrC,KAAK,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;QACjC,KAAK,MAAM,GAAG,IAAI,QAAQ,EAAE,CAAC;YAC3B,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC3D,KAAK,CAAC,IAAI,CAAC,QAAQ,GAAG,CAAC,IAAI,OAAO,OAAO,KAAK,GAAG,CAAC,QAAQ,CAAC,IAAI,GAAG,CAAC,CAAC;QACtE,CAAC;IACH,CAAC;IAED,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvB,OAAO,4BAA4B,CAAC;IACtC,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC;AAED,SAAgB,mBAAmB,CACjC,SAAoB,EACpB,mBAA6B,EAC7B,WAA4B,EAC5B,SAA2B,EAC3B,eAAiC,EACjC,WAAmB,OAAO,CAAC,GAAG,EAAE;IAEhC,MAAM,KAAK,GAAG,WAAW,CAAC,SAAS,CAAC,CAAC;IACrC,MAAM,gBAAgB,GAAG,oCAAsB,CAAC,SAAS,CAAC,IAAI,CAAC,yCAAyC,CAAC,CAAC;IAC1G,MAAM,aAAa,GAAG,kCAAoB,CAAC,SAAS,CAAC,IAAI,CAAC,+BAA+B,CAAC,CAAC;IAC3F,MAAM,aAAa,GAAG,IAAA,8CAAmB,EAAC,mBAAmB,CAAC,CAAC;IAE/D,MAAM,cAAc,GAAG,WAAW;SAC/B,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAK,KAAK,EAAE,CAAC,IAAI,GAAG,CAAC;SACxC,IAAI,CAAC,IAAI,CAAC,CAAC;IAEd,MAAM,iBAAiB,GAAG,gBAAgB,CAAC,eAAe,EAAE,QAAQ,CAAC,CAAC;IACtE,MAAM,eAAe,GAAG,cAAc,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IAC5D,MAAM,mBAAmB,GAAG,wBAAwB,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IAE1E,OAAO,KAAK,KAAK;;;mBAGA,KAAK,CAAC,WAAW,EAAE;;;EAGpC,UAAU,CAAC,gBAAgB,CAAC;;;EAG5B,UAAU,CAAC,aAAa,CAAC;;;;;;;;;EASzB,aAAa,IAAI,oDAAoD;;;EAGrE,eAAe;;EAEf,mBAAmB;EACnB,iBAAiB;;;EAGjB,cAAc;;;;;;;;;;CAUf,CAAC;AACF,CAAC;AAED,SAAS,WAAW,CAAC,SAAiB;IACpC,OAAO,SAAS;SACb,KAAK,CAAC,GAAG,CAAC;SACV,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;SAClE,IAAI,CAAC,GAAG,CAAC,CAAC;AACf,CAAC;AAED,SAAS,UAAU,CAAC,KAAe;IACjC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;QAClB,OAAO,6BAA6B,CAAC;IACvC,CAAC;IACD,OAAO,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACnD,CAAC"}
1
+ {"version":3,"file":"playbookTemplate.js","sourceRoot":"","sources":["../../../../src/generators/agents/templates/playbookTemplate.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAqHA,kDA+DC;AApLD,gDAA8E;AAE9E,oFAA4E;AAG5E,iEAA2E;AAC3E,2CAA6B;AAE7B;;;GAGG;AACH,SAAS,gBAAgB,CAAC,MAAqB,EAAE,QAAgB;IAC/D,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;IACrD,OAAO,MAAM,MAAM,CAAC,IAAI,OAAO,OAAO,KAAK,MAAM,CAAC,IAAI,GAAG,CAAC;AAC5D,CAAC;AAED;;;GAGG;AACH,SAAS,cAAc,CAAC,QAAgB,EAAE,QAAgB;IACxD,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IAClD,OAAO,MAAM,OAAO,OAAO,OAAO,GAAG,CAAC;AACxC,CAAC;AAED,SAAS,gBAAgB,CAAC,OAAoC,EAAE,QAAgB;IAC9E,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACrC,OAAO,mCAAmC,CAAC;IAC7C,CAAC;IAED,OAAO,OAAO;SACX,GAAG,CAAC,CAAC,CAAC,EAAE;QACP,MAAM,GAAG,GAAG,gBAAgB,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;QAC1C,OAAO,KAAK,GAAG,KAAK,CAAC,CAAC,IAAI,GAAG,CAAC;IAChC,CAAC,CAAC;SACD,IAAI,CAAC,IAAI,CAAC,CAAC;AAChB,CAAC;AAED,SAAS,wBAAwB,CAAC,SAAsC,EAAE,QAAgB;IACxF,IAAI,CAAC,SAAS,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;QACxD,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,MAAM,KAAK,GAAG,CAAC,yBAAyB,EAAE,EAAE,CAAC,CAAC;IAC9C,KAAK,MAAM,KAAK,IAAI,SAAS,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC;QAClD,MAAM,WAAW,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC;QACzC,MAAM,IAAI,GAAG,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC/D,KAAK,CAAC,IAAI,CAAC,OAAO,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;QAChC,KAAK,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC;QACnC,KAAK,CAAC,IAAI,CAAC,sBAAsB,IAAI,EAAE,CAAC,CAAC;QACzC,KAAK,CAAC,IAAI,CAAC,kBAAkB,WAAW,QAAQ,CAAC,CAAC;QAElD,sCAAsC;QACtC,MAAM,UAAU,GAAG,KAAK,CAAC,OAAO;aAC7B,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;QAE3B,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC1B,MAAM,UAAU,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE;gBACpC,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;gBACzD,OAAO,MAAM,CAAC,CAAC,IAAI,OAAO,OAAO,KAAK,CAAC,CAAC,QAAQ,CAAC,IAAI,GAAG,CAAC;YAC3D,CAAC,CAAC,CAAC;YACH,KAAK,CAAC,IAAI,CAAC,sBAAsB,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC5D,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC;IACD,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC;AAED,SAAS,cAAc,CAAC,SAAsC,EAAE,QAAgB;IAC9E,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,OAAO,4BAA4B,CAAC;IACtC,CAAC;IAED,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,eAAe;IACf,IAAI,SAAS,CAAC,YAAY,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAClD,KAAK,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;QAChC,KAAK,MAAM,EAAE,IAAI,SAAS,CAAC,YAAY,CAAC,WAAW,EAAE,CAAC;YACpD,KAAK,CAAC,IAAI,CAAC,KAAK,cAAc,CAAC,EAAE,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAC;QAClD,CAAC;IACH,CAAC;IAED,oBAAoB;IACpB,IAAI,SAAS,CAAC,YAAY,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC/C,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC;YAAE,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACrC,KAAK,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAC;QAC3C,KAAK,MAAM,OAAO,IAAI,SAAS,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC;YACtD,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;gBAC5C,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;gBAClD,OAAO,MAAM,GAAG,CAAC,MAAM,OAAO,OAAO,GAAG,CAAC;YAC3C,CAAC,CAAC,CAAC;YACH,KAAK,CAAC,IAAI,CAAC,KAAK,OAAO,CAAC,IAAI,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC3D,CAAC;IACH,CAAC;IAED,gDAAgD;IAChD,MAAM,QAAQ,GAAG,SAAS,CAAC,OAAO,CAAC,OAAO;SACvC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,CAAC;IAEzD,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACxB,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC;YAAE,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACrC,KAAK,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;QACjC,KAAK,MAAM,GAAG,IAAI,QAAQ,EAAE,CAAC;YAC3B,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC3D,KAAK,CAAC,IAAI,CAAC,QAAQ,GAAG,CAAC,IAAI,OAAO,OAAO,KAAK,GAAG,CAAC,QAAQ,CAAC,IAAI,GAAG,CAAC,CAAC;QACtE,CAAC;IACH,CAAC;IAED,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvB,OAAO,4BAA4B,CAAC;IACtC,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC;AAED,SAAgB,mBAAmB,CACjC,SAAoB,EACpB,mBAA6B,EAC7B,WAA4B,EAC5B,SAA2B,EAC3B,eAAiC,EACjC,WAAmB,OAAO,CAAC,GAAG,EAAE;IAEhC,MAAM,KAAK,GAAG,WAAW,CAAC,SAAS,CAAC,CAAC;IACrC,MAAM,gBAAgB,GAAG,oCAAsB,CAAC,SAAS,CAAC,IAAI,CAAC,yCAAyC,CAAC,CAAC;IAC1G,MAAM,aAAa,GAAG,kCAAoB,CAAC,SAAS,CAAC,IAAI,CAAC,+BAA+B,CAAC,CAAC;IAC3F,MAAM,aAAa,GAAG,IAAA,8CAAmB,EAAC,mBAAmB,CAAC,CAAC;IAE/D,MAAM,cAAc,GAAG,WAAW;SAC/B,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAK,KAAK,EAAE,CAAC,IAAI,GAAG,CAAC;SACxC,IAAI,CAAC,IAAI,CAAC,CAAC;IAEd,MAAM,iBAAiB,GAAG,gBAAgB,CAAC,eAAe,EAAE,QAAQ,CAAC,CAAC;IACtE,MAAM,eAAe,GAAG,cAAc,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IAC5D,MAAM,mBAAmB,GAAG,wBAAwB,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IAE1E,MAAM,OAAO,GAAG,KAAK,KAAK;;;mBAGT,KAAK,CAAC,WAAW,EAAE;;;EAGpC,UAAU,CAAC,gBAAgB,CAAC;;;EAG5B,UAAU,CAAC,aAAa,CAAC;;;;;;;;;EASzB,aAAa,IAAI,oDAAoD;;;EAGrE,eAAe;;EAEf,mBAAmB;EACnB,iBAAiB;;;EAGjB,cAAc;;;;;;;;;;;;CAYf,CAAC;IAEA,OAAO,IAAA,4BAAmB,EAAC,OAAO,CAAC,CAAC;AACtC,CAAC;AAED,SAAS,WAAW,CAAC,SAAiB;IACpC,OAAO,SAAS;SACb,KAAK,CAAC,GAAG,CAAC;SACV,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;SAClE,IAAI,CAAC,GAAG,CAAC,CAAC;AACf,CAAC;AAED,SAAS,UAAU,CAAC,KAAe;IACjC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;QAClB,OAAO,6BAA6B,CAAC;IACvC,CAAC;IACD,OAAO,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACnD,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"apiReferenceTemplate.d.ts","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/apiReferenceTemplate.ts"],"names":[],"mappings":"AAAA,wBAAgB,kBAAkB,IAAI,MAAM,CAgd3C"}
1
+ {"version":3,"file":"apiReferenceTemplate.d.ts","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/apiReferenceTemplate.ts"],"names":[],"mappings":"AAEA,wBAAgB,kBAAkB,IAAI,MAAM,CAkd3C"}
@@ -1,8 +1,9 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.renderApiReference = renderApiReference;
4
+ const common_1 = require("./common");
4
5
  function renderApiReference() {
5
- return `# API Reference
6
+ const content = `# API Reference
6
7
 
7
8
  **Purpose:** Enable AI agents to programmatically interact with all API endpoints.
8
9
 
@@ -465,5 +466,6 @@ Document webhook registration process if applicable.
465
466
  - Link to Postman collection for easy testing
466
467
  - Link to OpenAPI/Swagger specification if available
467
468
  `;
469
+ return (0, common_1.wrapWithFrontMatter)(content);
468
470
  }
469
471
  //# sourceMappingURL=apiReferenceTemplate.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"apiReferenceTemplate.js","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/apiReferenceTemplate.ts"],"names":[],"mappings":";;AAAA,gDAgdC;AAhdD,SAAgB,kBAAkB;IAChC,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA8cR,CAAC;AACF,CAAC"}
1
+ {"version":3,"file":"apiReferenceTemplate.js","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/apiReferenceTemplate.ts"],"names":[],"mappings":";;AAEA,gDAkdC;AApdD,qCAA+C;AAE/C,SAAgB,kBAAkB;IAChC,MAAM,OAAO,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA8cjB,CAAC;IAEA,OAAO,IAAA,4BAAmB,EAAC,OAAO,CAAC,CAAC;AACtC,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"architectureTemplate.d.ts","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/architectureTemplate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,4BAA4B,EAAE,MAAM,SAAS,CAAC;AAmHvD,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,4BAA4B,GAAG,MAAM,CA2ErF"}
1
+ {"version":3,"file":"architectureTemplate.d.ts","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/architectureTemplate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,4BAA4B,EAAE,MAAM,SAAS,CAAC;AAmHvD,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,4BAA4B,GAAG,MAAM,CAgFrF"}