doc-detective

Doc Detective Agent Tools

Agent tools for testing documentation procedures and validating that documented workflows match actual application behavior. Compatible with Gemini CLI, Claude Code, Cursor, Codex, OpenCode, GitHub Copilot, and other AI coding agents that support plugins, skills, or commands.

• Set up Doc Detective for a project. Initialize Doc Detective in a project with automatic documentation detection, config generation, and test creation.
• Generate tests. Convert documentation into executable test specifications.
• Run tests. Execute tests against your application and report results.
• Inject tests into your docs content. Embed test steps close to associated documentation content.
• Install the Doc Detective GitHub Action. Add a Doc Detective GitHub Actions workflow for automated documentation testing in CI.

Installation

Claude Code

1. Open Claude Code:

   claude
   

2. Add the Doc Detective marketplace and plugin:

   /plugin marketplace add doc-detective/agent-tools
   /plugin install doc-detective@doc-detective
   

3. Ask about Doc Detective, or use the init command to get started:

   /doc-detective-init
   

Gemini CLI

1. Install the extension and open Gemini CLI:

   gemini extensions install https://github.com/doc-detective/agent-tools.git --auto-update
   gemini
   

2. Ask about Doc Detective, or use the init command to get started:

   /doc-detective-init
   

Copilot CLI

1. Open Copilot CLI:

   copilot
   

2. Install the Doc Detective plugin:

   /plugin marketplace add doc-detective/agent-tools
   /plugin install doc-detective@doc-detective
   

3. Ask about Doc Detective, or use the init command to get started:

   /doc-detective-init
   

Qwen Code

1. Install the plugin and open Qwen Code:

   qwen extensions install https://github.com/doc-detective/agent-tools
   qwen extensions install doc-detective:doc-detective
   qwen
   

2. Ask about Doc Detective, or use the init command to get started:

   /doc-detective-init
   

Codex, Cursor, OpenCode, and other agents

Option 1: Install with npx skills

[!WARNING] npx skills only installs skills, not agents, commands, or other tools. For full functionality, consider manual installation.

Install these skills with the skills package from Vercel. This works with Claude Code, Cursor, Codex, OpenCode, and other AI coding tools.

npx skills add doc-detective/agent-tools

Follow the prompts. The CLI auto-detects which AI tools you have installed and places the skills in the appropriate directories.

Option 2: Manual Installation

Copy to your project directory

git clone https://github.com/doc-detective/agent-tools.git

cp -r agent-tools/agents .{agent-dir}/agents      # Agents
cp -r agent-tools/commands .{agent-dir}/commands  # Commands
cp -r agent-tools/skills .{agent-dir}/skills      # Skills
cp -r agent-tools/hooks .{agent-dir}/hooks        # Hooks

[!IMPORTANT] Adjust the destination path based on your agent's expected skill/plugin directory. For example, .agents for Codex, .cursor for Cursor, etc.

Usage

Bootstrap Doc Detective for a Project

/doc-detective-init

Initializes Doc Detective in your repository by:

1. Detecting documentation files
2. Generating a minimal configuration
3. Creating tests for identified procedures
4. Running tests
5. Iteratively fixing failures with confidence-based suggestions

Convert Documentation to Tests

/doc-detective-generate path/to/documentation.md

Identify testable procedures and convert them into Doc Detective test specifications.

Run Tests

/doc-detective-test path/to/documentation.md

Runs tests from docs or test specification files:

1. Extracts step-by-step procedures from your documentation.
2. Converts them to Doc Detective test specifications.
3. Validates the test specs.
4. Executes tests using Doc Detective.
5. Reports results with any failures mapped back to documentation sections.

Validate Test Specifications

/doc-detective-validate test-spec.json

Validates structure before execution:

• Required fields present
• Action types recognized
• Parameter types correct

Inject Tests into Documentation

/doc-detective-inject tests/spec.yaml docs/procedure.md --apply

Takes a well-formed test specification and injects test steps as inline comments into the associated documentation content so you don't have to maintain separate files.

Install the Doc Detective GitHub Action

/doc-detective-install-github-action [options]

Installs a Doc Detective GitHub Actions workflow for automated documentation testing in CI: