Skip to content

Latest commit

 

History

History
361 lines (252 loc) · 6.16 KB

API.md

File metadata and controls

361 lines (252 loc) · 6.16 KB

Directory Indexer API Reference

CLI Commands

All commands support the -v, --verbose flag for detailed logging.

index

Index directories for semantic search.

npx directory-indexer index <paths...> [options]

Arguments:

  • <paths...> - One or more directory paths to index

Options:

  • -v, --verbose - Enable verbose logging

Examples:

npx directory-indexer index /home/user/docs
npx directory-indexer index ./projects/api-docs ./work/reports
npx directory-indexer index --verbose /opt/documentation

search

Search indexed content semantically.

npx directory-indexer search <query> [options]

Arguments:

  • <query> - Search query text

Options:

  • -l, --limit <number> - Maximum results (default: 10)
  • -c, --show-chunks - Show individual chunk scores and IDs
  • -v, --verbose - Enable verbose logging

Examples:

npx directory-indexer search "database timeout errors and connection retry strategies"
npx directory-indexer search "JWT authentication implementation patterns" --limit 5
npx directory-indexer search "comprehensive error handling and logging practices" --show-chunks

similar

Find files similar to a given file.

npx directory-indexer similar <file> [options]

Arguments:

  • <file> - Path to reference file

Options:

  • -l, --limit <number> - Maximum results (default: 10)
  • -v, --verbose - Enable verbose logging

Examples:

npx directory-indexer similar ./docs/api-guide.md
npx directory-indexer similar /home/user/incident.md --limit 5

get

Get file content with optional chunk selection.

npx directory-indexer get <file> [options]

Arguments:

  • <file> - Path to file

Options:

  • -c, --chunks <range> - Chunk range (e.g., "2-5")
  • -v, --verbose - Enable verbose logging

Examples:

npx directory-indexer get ./docs/auth-guide.md
npx directory-indexer get ./deployment.md --chunks 2-4

serve

Start MCP server for AI assistant integration.

npx directory-indexer serve [options]

Options:

  • -v, --verbose - Enable verbose logging

Examples:

npx directory-indexer serve
npx directory-indexer serve --verbose

reset

Reset directory-indexer data (database and vector collection).

npx directory-indexer reset [options]

Options:

  • --force - Skip confirmation prompt
  • -v, --verbose - Enable verbose logging

Examples:

npx directory-indexer reset
npx directory-indexer reset --force
npx directory-indexer reset --verbose

status

Show indexing status and statistics.

npx directory-indexer status [options]

Options:

  • -v, --verbose - Show detailed error information

Examples:

npx directory-indexer status
npx directory-indexer status --verbose

MCP Tools

Available when running as MCP server (npx directory-indexer serve).

index

Index directories for semantic search.

Input Schema:

{
  "directory_path": "/home/user/docs,/opt/projects"
}

Response:

Indexed 145 files, skipped 12 files, 0 errors

search

Search indexed content semantically.

Input Schema:

{
  "query": "authentication issues and login failures",
  "limit": 10,
  "workspace": "customer_cases"
}

Response:

[
  {
    "filePath": "C:\\Users\\john\\Documents\\Support\\Cases\\redis-timeout.md",
    "score": 0.89,
    "fileSizeBytes": 2048,
    "matchingChunks": 3,
    "chunks": [
      {
        "chunkId": "chunk_1",
        "score": 0.92
      },
      {
        "chunkId": "chunk_3",
        "score": 0.87
      }
    ]
  }
]

similar_files

Find files similar to a given file.

Input Schema:

{
  "file_path": "C:\\Users\\john\\Documents\\Support\\Cases\\auth-failure.md",
  "limit": 10,
  "workspace": "customer_cases"
}

Response:

[
  {
    "filePath": "C:\\Users\\john\\Documents\\Incidents\\redis-timeout.md",
    "score": 0.91,
    "fileSizeBytes": 1536
  }
]

get_content

Get file content with optional chunk selection.

Input Schema:

{
  "file_path": "/home/user/docs/api-guide.md",
  "chunks": "2-5"
}

Response:

# API Authentication Guide

This document covers authentication patterns...

get_chunk

Get content of a specific chunk by file path and chunk ID.

Input Schema:

{
  "file_path": "/home/user/docs/api-guide.md",
  "chunk_id": "chunk_2"
}

Response:

# API Authentication

This section covers authentication methods...

server_info

Get server information and status.

Input Schema:

{}

Response:

{
  "name": "directory-indexer",
  "version": "0.0.10",
  "status": {
    "directoriesIndexed": 3,
    "filesIndexed": 1247,
    "chunksIndexed": 3891,
    "databaseSize": "15.2 MB",
    "lastIndexed": "2025-01-15T10:30:00Z",
    "errors": [],
    "workspaces": [
      {
        "name": "customer_cases",
        "paths": ["C:\\Users\\john\\Documents\\Support\\Cases", "C:\\Users\\john\\Documents\\Incidents"],
        "isValid": true,
        "filesCount": 156,
        "chunksCount": 892
      },
      {
        "name": "engineering_docs",
        "paths": ["C:\\Users\\john\\Code\\API", "C:\\Users\\john\\Code\\Web"],
        "isValid": true,
        "filesCount": 1091,
        "chunksCount": 2999
      }
    ]
  }
}

Error Handling

All commands use exit code 1 for errors. Error messages are written to stderr.

Common Error Types:

  • Configuration errors (missing services)
  • File access errors (permissions, not found)
  • Network errors (Qdrant/Ollama unavailable)
  • Processing errors (unsupported file types)

Example Error Output:

Error indexing directories: Failed to connect to Qdrant at http://localhost:6333
Check that Qdrant is running: docker run -p 127.0.0.1:6333:6333 qdrant/qdrant

Configuration

See Environment Variables for complete configuration options.

Supported File Types

  • Text: .md, .txt
  • Code: .rs, .py, .js, .ts, .go, .java, etc.
  • Data: .json, .yaml, .csv, .toml
  • Config: .env, .conf, .ini