docs-agent 1.1.0 → 1.1.1

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [1.1.1](https://github.com/rudderlabs/docs-agent/compare/v1.1.0...v1.1.1) (2026-02-19)
+
+
+### Bug Fixes
+
+* change content order in docs review output ([#75](https://github.com/rudderlabs/docs-agent/issues/75)) ([600d280](https://github.com/rudderlabs/docs-agent/commit/600d28088fe7a30c68c31feae499916c70f30bb7))
+
 ## [1.1.0](https://github.com/rudderlabs/docs-agent/compare/v1.0.2...v1.1.0) (2025-11-20)
 
 

package/env.example

@@ -12,6 +12,7 @@ MAX_TOKENS=8000
 OLLAMA_API_KEY=sk-ollama-1234567890
 OLLAMA_API_URL=http://localhost:11434/api/generateGEMINI_API_KEY=#deprecated
 GOOGLE_GENERATIVE_AI_API_KEY=
+GEMINI_API_KEY=#alias for GOOGLE_GENERATIVE_AI_API_KEY
 OPENAI_API_KEY=sk-proj-1234567890
 ANTHROPIC_API_KEY=sk-ant-api03-1234567890
 OTEL_EXPORTER_OTLP_ENDPOINT=https://api.braintrust.dev/otel

package/package.json

@@ -1,11 +1,23 @@
 {
   "name": "docs-agent",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "Docs-Agent leverages AI to avoid outdated documentation, fix issues related to comprehensiblity or technical accuracy.",
-  "main": "src/index.js",
+  "main": "src/lib.js",
+  "exports": {
+    ".": "./src/lib.js"
+  },
+  "bin": {
+    "docs-agent": "./src/cli.js"
+  },
   "type": "module",
   "license": "MIT",
-  "files": ["src", "README.md", "LICENSE", "CHANGELOG.md", "env.example", "docs"],
+  "files": [
+    "src",
+    "README.md",
+    "LICENSE",
+    "CHANGELOG.md",
+    "env.example"
+  ],
   "scripts": {
     "test": "mocha test/**/*.test.js",
     "start": "node src/index.js",

package/src/LogUtility.js

@@ -0,0 +1,6 @@
+export function configureLogsForMcp(consoleRef = console) {
+  consoleRef.log = consoleRef.error;
+  consoleRef.debug = consoleRef.error;
+  consoleRef.info = consoleRef.error;
+  consoleRef.warn = consoleRef.error;
+}

package/src/cli.js

@@ -0,0 +1,77 @@
+#!/usr/bin/env node
+
+import 'dotenv/config';
+import path from 'path';
+import api from './api.js';
+import mcp from './mcp.js';
+import { DocsAgent } from './lib.js';
+import { configureLogsForMcp } from './LogUtility.js';
+
+// CLI: no args / mcp → MCP server; api [--port=N] → API server; review <filepath> → DocsAgent.review
+
+const args = process.argv.slice(2);
+const subcommand = args[0];
+
+function parseFlags(rest) {
+  const opts = {};
+  for (const arg of rest) {
+    if (arg.startsWith('--port=')) opts.port = arg.slice(7);
+    else if (arg.startsWith('--filename=')) opts.filename = arg.slice(11);
+    else if (arg.startsWith('--project-structure=')) opts.projectStructure = arg.slice(20);
+    else if (arg.startsWith('--instructions=')) opts.instructions = arg.slice(15);
+  }
+  return opts;
+}
+
+async function runMcp() {
+  configureLogsForMcp();
+  await mcp.start();
+}
+
+async function runApi(portArg) {
+  const port = portArg || process.env.PORT || 3001;
+  api.start(port);
+}
+
+async function runReview(filepath, opts) {
+  if (!filepath) {
+    console.error('Usage: docs-agent review <filepath> [--filename=...] [--project-structure=...] [--instructions=...]');
+    process.exit(1);
+  }
+  const absolutePath = path.isAbsolute(filepath) ? filepath : path.resolve(process.cwd(), filepath);
+  const agent = new DocsAgent('mcp');
+  const context = { filepath: absolutePath };
+  if (opts.filename) context.filename = opts.filename;
+  if (opts.projectStructure) context.projectStructure = opts.projectStructure;
+  const review = await agent.review(null, context, opts.instructions);
+  console.log(review);
+}
+
+async function main() {
+  if (!subcommand || subcommand === 'mcp') {
+    await runMcp();
+    return;
+  }
+  if (subcommand === 'api') {
+    const flags = parseFlags(args.slice(1));
+    await runApi(flags.port);
+    return;
+  }
+  if (subcommand === 'review') {
+    const filepath = args[1];
+    const flags = parseFlags(args.slice(2));
+    await runReview(filepath, flags);
+    return;
+  }
+  console.error(`Unknown subcommand: ${subcommand}`);
+  console.error('Usage: docs-agent [mcp|api|review ...]');
+  console.error('  (no args) or mcp  → start MCP server');
+  console.error('  api [--port=N]    → start HTTP API server');
+  console.error('  review <filepath> [--filename=...] [--project-structure=...] [--instructions=...]');
+  process.exit(1);
+}
+
+main().catch((err) => {
+  console.error(err);
+  process.exit(1);
+});

package/src/config/prompt.review.js

@@ -12,10 +12,11 @@ ${PRINCIPLES}
 ${SCORING_PROMPT}
 
 ## Output format
-- Analysis summary of the documentation.
+- Documentation file being reviewed: <filepath>
+- Analysis summary.
 - An objective rating score of the documentation.
-- A list of actionable suggestions for the documentation.
-- A list of the documentation's strengths.
+- A concise list of the documentation's strengths.
+- A list of actionable suggestions for the documentation. (most important part of the output)
 - Do not add any other text or comments.
 
 `;

package/src/index.js

@@ -1,6 +1,7 @@
 import 'dotenv/config';
 import api from './api.js';
 import mcp from './mcp.js';
+import { configureLogsForMcp } from './LogUtility.js';
 import fs from 'fs';
 import path from 'path';
 
@@ -15,14 +16,6 @@ if(process.env.MCP_DISABLED !== 'true'){
   mcp.start();
 }
 
-function configureLogsForMcp(){
-  console.log = console.error;
-  // console.error = () => {};
-  console.debug = console.error;
-  console.info = console.error;
-  console.warn = console.error;
-}
-
 function setupPersistentLogs(filename){
   // Override console methods
   console.log = logToFile;

package/docs/DEPLOYMENT.md

@@ -1,142 +0,0 @@
-## Deployment Guide
-
-This guide covers deploying Docs-Agent as a container (recommended), with Docker Compose, or directly on a host (bare metal). It exposes an HTTP API on port 3001 when `API_DISABLED=false` and can be run as an MCP server with `MCP_DISABLED=false`.
-
-### Prerequisites
-- Node.js v20+ (bare-metal or MCP usage)
-- Docker 24+ (for containerized deployment)
-- Optional: Docker Compose v2+
-- Required secrets (at least):
-  - `GOOGLE_GENERATIVE_AI_API_KEY`
-  - `ANTHROPIC_API_KEY`
-  - `GITHUB_TOKEN` (for code search)
-
-Additional configuration (optional):
-- `API_KEY` for API security
-- `PREFERRED_AI_SERVICE`, `PREFERRED_AI_MODEL`, `REVIEW_AI_SERVICE`, `REVIEW_AI_MODEL`
-- `OTEL_EXPORTER_OTLP_ENDPOINT`, `OTEL_EXPORTER_OTLP_HEADERS` for observability
-- `MAX_TOKENS`, `MAX_CHANGES`, `ALLOW_DISRUPTIVE_CHANGES`
-- SSRF Protection:
-  - `ALLOWED_WEBHOOK_URLS` for webhook endpoints (exact URLs only)
-  - `RESULTS_WEBHOOK_KEY` for authenticating webhook requests (optional, sent as `x-api-key` header)
-  - `REMOTE_FILE_ALLOWED_HOSTS` for remote file access (hostnames only)
-  - `REMOTE_FILE_ALLOW_CUSTOM_HOSTS` to enable custom hosts (default: false)
-
-Environment defaults are shown in `env.example` and `docker-compose.yml`.
-
----
-
-### Option A: Docker (single container)
-1. Build the image:
-   ```bash
-   docker build -t docs-agent:latest .
-   ```
-2. Run the container (API mode):
-   ```bash
-   docker run --rm \
-     -p 3001:3001 \
-     -e NODE_ENV=production \
-     -e PORT=3001 \
-     -e API_DISABLED=false \
-     -e MCP_DISABLED=true \
-     -e API_KEY=secret_api_key \
-     -e GOOGLE_GENERATIVE_AI_API_KEY=your_gemini_key \
-     -e ANTHROPIC_API_KEY=your_anthropic_key \
-     -e GITHUB_TOKEN=your_github_pat \
-     -e ALLOWED_WEBHOOK_URLS=https://github.app.url/api/comment \
-     -e RESULTS_WEBHOOK_KEY=your_webhook_auth_key \
-     -e REMOTE_FILE_ALLOWED_HOSTS=raw.githubusercontent.com \
-     docs-agent:latest
-   ```
-
-Health check: `GET http://localhost:3001/health` should return 200.
-
-Notes
-- The image runs as a non-root `nodejs` user.
-- Port 3001 is exposed; adjust with `-e PORT=... -p host:container`.
-
----
-
-### Option B: Docker Compose (recommended for local/dev)
-Use the provided `docker-compose.yml`:
-
-```bash
-docker compose up --build
-```
-
-Then check: `curl http://localhost:3001/health`.
-
-Customize environment by editing `docker-compose.yml` or using an `.env` file. Ensure you set valid keys for:
-- `GOOGLE_GENERATIVE_AI_API_KEY`
-- `ANTHROPIC_API_KEY`
-- `GITHUB_TOKEN`
-- `API_KEY`
-
-For SSRF protection, configure:
-- `ALLOWED_WEBHOOK_URLS` - exact webhook URLs (comma-separated)
-- `RESULTS_WEBHOOK_KEY` - API key to authenticate webhook requests (optional, sent as `x-api-key` header)
-- `REMOTE_FILE_ALLOWED_HOSTS` - allowed hosts for remote file access
-- `REMOTE_FILE_ALLOW_CUSTOM_HOSTS` - set to "true" to enable custom hosts
-
----
-
-### Option C: Bare metal (Node.js on host)
-1. Install dependencies:
-   ```bash
-   npm ci --only=production
-   ```
-2. Configure environment (copy and edit):
-   ```bash
-   cp env.example .env
-   # edit .env -> set API_DISABLED=false and add your keys
-   ```
-3. Start the server:
-   ```bash
-   npm start
-   ```
-4. Verify:
-   ```bash
-   curl http://localhost:3001/health
-   ```
-
-For MCP usage (no HTTP API), set `MCP_DISABLED=false` and `API_DISABLED=true`, then point your MCP client (e.g., Cursor Custom Mode) to `node src/index.js`. See `README.md` for an example MCP client configuration.
-
----
-
-### Configuration Reference
-- `API_DISABLED` (default true in example): set to `false` to enable HTTP API
-- `API_KEY`, always set this to a secret value to secure API endpoints
-- `MCP_DISABLED`: set to `false` to enable MCP server tools
-- `GOOGLE_GENERATIVE_AI_API_KEY`, `ANTHROPIC_API_KEY`: required for AI operations
-- `GITHUB_TOKEN`: required for auditing docs against code in private/public repos
-- `PREFERRED_AI_SERVICE`/`MODEL` and `REVIEW_AI_SERVICE`/`MODEL`: control model choices
-- `MAX_TOKENS`, `MAX_CHANGES`, `ALLOW_DISRUPTIVE_CHANGES`: safety/quality controls
-- Observability: set `OTEL_EXPORTER_OTLP_ENDPOINT` and `OTEL_EXPORTER_OTLP_HEADERS` to enable OTEL traces
-- SSRF Protection:
-  - `ALLOWED_WEBHOOK_URLS`: exact webhook URLs only (comma-separated)
-  - `RESULTS_WEBHOOK_KEY`: API key for webhook authentication (optional, sent as `x-api-key` header)
-  - `REMOTE_FILE_ALLOWED_HOSTS`: allowed hosts for remote file reads (comma-separated)
-  - `REMOTE_FILE_ALLOW_CUSTOM_HOSTS`: enable custom hosts (default: false)
-
-All variables and defaults are documented in `env.example`.
-
----
-
-### Security and Operations
-- Provide secrets via environment variables or secret stores (never bake into images).
-- The container uses a non-root user and a health check.
-- Run behind an API gateway or reverse proxy in production; add rate limits and auth as needed.
-- **Path Traversal Protection**: 
-  - API mode: Restricts file access to `public/` subdirectory only
-  - MCP mode: Allows unrestricted local file access (relies on MCP client permissions)
-  - Both modes: Allow validated remote file access (GitHub/GitLab URLs)
-- SSRF Protection: Configure webhook and remote file allowlists to prevent unauthorized requests.
-
----
-
-### Troubleshooting
-- Health endpoint not ready: allow the container start period defined in Dockerfile/Compose.
-- 401/403 errors from code search: verify `GITHUB_TOKEN` scopes (typically `repo`).
-- AI errors: verify keys and model names; ensure region/product access with providers.
-
-

package/docs/mcp-client-prompt.md

@@ -1,26 +0,0 @@
-You are a helpful team member to coordinate documentation improvements tasks between the user and the MCP tools such as docs-agent.
-User will ask you for documentation improvements tasks or advice.
-You will then choose the appropriate MCP tools from docs-agent based on the task requirements.
-
-## MCP Tool Usage Guidelines
-- Always use the docs-agent's tools for docs improvement to get the improved docs content.
-- Make sure to pass the necessary content to docs-agent such as the file content and context e.g. project structure, etc.
-- Always send the glossary page content as glossary parameter for the tool that requires it.
-- For tools that require specific files or information, find the related files or information from the source code or project context.
-- If the RudderStack documentation style guide rule (rudderstack-style.mdc) is available, provide its complete content in the custom instructions to ensure that the docs-agent output follows the RudderStack style.
-- The file paths must always be either absolute path or a remote url path
-- Always apply the docs-agent results as it is in the code immediately after they are received
-- Always show the audit or review results to ensure the reasoning behind the changes
-
-## Finding related files
-- Based on the user goal, decide which files are the most relevant files for additional context
-- A file mentioned in the page could be a relevant file if the understanding of the page depends on that file content
-- Sibling files under the immediate parent folder are sometimes relevant as they relate to the same concept
-- Do not make up the filepath, always list files and then pick the filepath from there
-
-## Boundaries
-- **Do not** make any additional changes to the docs-agent tool output, your job is to only apply those changes to current file content as it is. 
-- Make sure the final file content matches the agent's version completely after applying the diff.
-- Remember to apply all the changes as it is, no additional changes or addition or deletion from your side.
-- Do not make changes to the file content that is not related to the returned docs content.
-- Do not ask the user to apply the changes returned by `improveDocs` or `editDocs` tools — just apply them directly.

package/docs/reference.md

@@ -1,258 +0,0 @@
-`docs-agent` is an AI-powered agent for continuous documentation improvement. It analyzes, reviews, and edits documentation files using advanced LLMs (Gemini, Claude, etc.), following the Diátaxis documentation framework. It exposes its functionality via an HTTP API, an MCP (Model Context Protocol) server, and a programmatic Node.js interface.
-
-## 1. MCP Server Tools
-
-The MCP server exposes the following tools for integration with Model Context Protocol clients:
-
-### `reviewDocs`
-
-- **Description:** Reviews documentation quality following the Diátaxis framework.
-- **Parameters:**
-  - `filepath` (`string`): Absolute path to the docs file.
-  - `filename` (`string`, optional): Relative path from project root.
-  - `projectStructure` (`string`, optional): Project structure in markdown list format.
-  - `customInstructions` (`string`, optional): Additional instructions.
-  - `glossaryFile` (`string`, optional): Path to glossary file.
-  - `relatedFiles` (`string[]`, optional): Absolute filepaths of related docs files.
-  - `allowDisruptiveChanges` (`boolean`, optional, default: false): Allow major restructuring.
-- **Returns:** `{ content: [{ type: "text", text: string }] }`
-
-### `improveDocs`
-
-- **Description:** Improves documentation quality following the Diátaxis framework.
-- **Parameters:**
-  - `filepath` (`string`): Absolute path to the docs file.
-  - `filename` (`string`, optional): Relative path from project root.
-  - `projectStructure` (`string`, optional): Project structure in markdown list format.
-  - `customInstructions` (`string`, optional): Additional instructions.
-  - `glossaryFile` (`string`, optional): Path to glossary file.
-  - `relatedFiles` (`string[]`, optional): Absolute filepaths of related docs files.
-  - `allowDisruptiveChanges` (`boolean`, optional, default: false): Allow major restructuring.
-- **Returns:** `{ content: [{ type: "text", text: string }] }`
-
-### `editDocs`
-
-- **Description:** Edits documentation according to the provided plan.
-- **Parameters:**
-  - `filepath` (`string`): Absolute path to the docs file.
-  - `editPlan` (`string`): Specific changes to be made to the documentation.
-  - `filename` (`string`, optional): Relative path from project root.
-  - `projectStructure` (`string`, optional): Project structure in markdown list format.
-  - `customInstructions` (`string`, optional): Additional instructions.
-  - `glossaryFile` (`string`, optional): Path to glossary file.
-  - `relatedFiles` (`string[]`, optional): Absolute filepaths of related docs files.
-- **Returns:** `{ content: [{ type: "text", text: string }] }`
-
-### `linkifyDocs`
-
-- **Description:** Improves internal linking to related files and glossary concepts.
-- **Parameters:**
-  - `filepath` (`string`): Absolute path to the docs file.
-  - `filename` (`string`, optional): Relative path from project root.
-  - `projectStructure` (`string`, optional): Project structure in markdown list format.
-  - `customInstructions` (`string`, optional): Additional instructions.
-  - `glossaryFile` (`string`, optional): Path to glossary file.
-  - `relatedFiles` (`string[]`, optional): Absolute filepaths of related docs files.
-- **Returns:** `{ content: [{ type: "text", text: string }] }`
-
-### `auditDocsAgainstCode`
-
-- **Description:** Audits documentation against the corresponding codebase for accuracy and completeness.
-- **Parameters:**
-  - `docsContentFilePath` (`string`): Absolute path to the docs file to audit.
-  - `repoUrl` (`string`): GitHub repository URL for the reference source code.
-  - `projectStructure` (`string`, optional): Project structure in markdown list format.
-  - `customInstructions` (`string`, optional): Additional instructions.
-- **Returns:** `{ content: [{ type: "text", text: string }] }`
-
-### `generateReferenceDocs` (Experimental)
-
-- **Description:** Generates reference documentation for the given codebase/content.
-- **Parameters:**
-  - `referenceSourceCodeFiles` (`string[]`): Remote URLs of the necessary source code files.
-  - `repoUrl` (`string`, optional): GitHub repository URL.
-  - `interfaceType` (`"library" | "http" | "mcp" | "cli" | "rpc" | "other"`, optional): Type of interface.
-  - `relatedFileUrls` (`string[]`, optional): Remote URLs of related code files.
-  - `projectStructure` (`string`, optional): Project structure in markdown list format.
-  - `customInstructions` (`string`, optional): Additional instructions.
-  - `knowledgeBase` (`string`, optional): Higher-level architecture context (not included in output).
-- **Returns:** `{ content: [{ type: "text", text: string }] }`
-- **Note:** This tool is experimental and disabled by default.
-
-----
-
-## 2. Node.js Library API
-
-### Example Usage
-
-```js
-const docsAgent = new DocsAgent();
-const editedDocsPageContent = await docsAgent.reviewPrioritizeAndEdit(contentToEdit, {
-  projectStructure: "- src/\n  - DocsAgent.js\n  - api.js\n  - mcp.js\n  - LLM.js\n - config/\n    - principles.diataxis.js",
-  customInstructions: "make sure the final output is a hugo markdown file"
-});
-console.log(editedDocsPageContent);
-```
-
-### DocsAgent Class
-
-The main class for documentation improvement operations.
-
-#### Constructor
-
-```js
-new DocsAgent();
-```
-
-- Initializes a new DocsAgent instance.
-
-#### Methods
-
-##### `reviewPrioritizeAndEdit(content, context = {}, customInstructions, isFileWriteAllowed)`
-
-- **Description:** Plans and executes the documentation improvement process: review, prioritize, and edit.
-- **Parameters:**
-  - `content` (`string`): The documentation content to improve. If not provided, `context.filepath` is required.
-  - `context` (`object`):
-    - `filepath` (`string`): Absolute or relative path to the docs file.
-    - `filename` (`string`): Name of the docs file.
-    - `projectStructure` (`string`): Project structure in markdown list format.
-    - `glossaryFile` (`string`): Path to glossary file for consistent terminology.
-    - `relatedFiles` (`string[]`): Absolute filepaths to related documentation files.
-    - `allowDisruptiveChanges` (`boolean`): Allow major restructuring (default: false).
-  - `customInstructions` (`string`): Additional instructions for the improvement process.
-  - `isFileWriteAllowed` (`boolean`): If true, saves original and edited files to disk.
-- **Returns:** `Promise<string>` (the improved documentation content).
-
-##### `review(content, context, customInstructions)`
-
-- **Description:** Reviews documentation and suggests improvements.
-- **Parameters:**  
-  - `content` (`string`): Documentation to review.
-  - `context` (`object`): Context for the review (see above).
-  - `customInstructions` (`string`): Additional instructions.
-- **Returns:** `Promise<string>` (review summary, rating, suggestions, strengths).
-
-##### `prioritize(content, review, context, customInstructions)`
-
-- **Description:** Breaks down the review into prioritized editing tasks.
-- **Parameters:**  
-  - `content` (`string`): Documentation to review.
-  - `review` (`string`): Review output.
-  - `context` (`object`): Context for prioritization.
-  - `customInstructions` (`string`): Additional instructions.
-- **Returns:** `Promise<string>` (prioritized editing plan).
-
-##### `edit(content, editPlan, context, customInstructions)`
-
-- **Description:** Edits documentation according to the provided plan.
-- **Parameters:**  
-  - `content` (`string`): Documentation to edit.
-  - `editPlan` (`string`): Editing plan.
-  - `context` (`object`): Context for editing.
-  - `customInstructions` (`string`): Additional instructions.
-- **Returns:** `Promise<string>` (edited documentation).
-
-##### `linkify(content, context, customInstructions)`
-
-- **Description:** Improves internal linking to related files and glossary concepts.
-- **Parameters:**  
-  - `content` (`string`): Documentation to linkify.
-  - `context` (`object`): Context for linking.
-  - `customInstructions` (`string`): Additional instructions.
-- **Returns:** `Promise<string>` (content with improved links).
-
-##### `generateReferenceDocs(referenceSourceCodeFiles, context, customInstructions)`
-
-- **Description:** Generates reference documentation for the given content.
-- **Parameters:**  
-  - `referenceSourceCodeFiles` (`string[]`): Remote URLs of the necessary source code files.
-  - `context` (`object`): Context for generation.
-    - `interfaceType` (`string`): Type of interface ("library", "http", "mcp", "cli", "rpc", or "other").
-    - `repoUrl` (`string`): URL of the repository.
-    - `projectStructure` (`string`): Project structure in markdown list format.
-    - `relatedFileUrls` (`string[]`): Remote URLs of related code files.
-    - `knowledgeBase` (`string`): Higher-level architecture context (not included in output).
-  - `customInstructions` (`string`): Additional instructions.
-- **Returns:** `Promise<string>` (reference documentation).
-
-##### `auditDocsAgainstCode(docsContentFilePath, context, customInstructions)`
-
-- **Description:** Audits documentation against the corresponding codebase for accuracy and completeness.
-- **Parameters:**
-  - `docsContentFilePath` (`string`): Absolute path to the docs file to audit.
-  - `context` (`object`): Context for the audit.
-    - `repoUrl` (`string`): GitHub repository URL for the reference source code.
-    - `projectStructure` (`string`): Project structure in markdown list format.
-  - `customInstructions` (`string`): Additional instructions.
-- **Returns:** `Promise<string>` (audit report with discrepancies and suggestions).
-
----
-
-## 3. HTTP API
-
-The HTTP API is served via Express (default port: 3001).
-
-### Endpoints
-
-#### `POST /review`
-
-- **Request Body:** `{ content: string, filename?: string }`
-- **Response:** Review summary, rating, suggestions, strengths.
-
-#### `POST /prioritize`
-
-- **Request Body:** `{ content: string, review: string }`
-- **Response:** Prioritized actionable instructions.
-
-#### `POST /edit`
-
-- **Request Body:** `{ content: string, editPlan?: string, filename?: string }`
-- **Response:** Edited documentation content.
-
-#### `GET /health`
-
-- **Response:** Service status, version, uptime, memory, CPU usage.
-
----
-
-## Prompts and Principles
-
-The agent uses a set of configurable prompts and principles (in `src/config/`) to guide its review, prioritization, editing, and linking operations. These include:
-
-- Diátaxis documentation principles
-- Technical accuracy principles
-- Writing and formatting style guides
-- Linking rules
-
----
-
-## Environment Variables
-
-- `GITHUB_TOKEN` - GitHub personal access token
-- `REVIEW_AI_SERVICE` (Default: `gemini`) - AI service to be used for the documentation analysis part e.g. gemini, anthropic, etc.
-- `REVIEW_AI_MODEL` (Default: `gemini-2.5-pro-preview-05-06`) - AI model to be used for the documentation analysis part
-- `PREFERRED_AI_SERVICE` (Default: `anthropic`) - Preferred AI service
-- `PREFERRED_AI_MODEL` (Default: `claude-3-5-sonnet-20240620`) - Preferred AI model
-- `GOOGLE_GENERATIVE_AI_API_KEY` - Google AI API key
-- `ANTHROPIC_API_KEY` - Anthropic API key
-- `OPENAI_API_KEY` - OpenAI API key
-- `OLLAMA_API_KEY` - Ollama API key
-- `OLLAMA_API_URL` - Ollama API URL
-- `API_DISABLED` - Must not be "true" to serve the project as an HTTP API
-- `MCP_DISABLED` - Must not be "true" to serve the project as an MCP server
-- `MAX_CHANGES` - Maximum number of changes allowed
-- `ALLOW_DISRUPTIVE_CHANGES` - Whether to allow disruptive changes
-- `MAX_TOKENS` - Maximum tokens for LLM requests
-
----
-
-## Folder and File Structure
-
-- `src/DocsAgent.js`: Main agent logic.
-- `src/LLM.js`: LLM interface.
-- `src/api.js`: HTTP API server.
-- `src/mcp.js`: MCP server and tool definitions.
-- `src/config/`: Prompts, principles, and configuration.
-- `test/`: Tests and fixtures.
-- `docs/`: Documentation.