Skip to content

Latest commit

 

History

History

docs

README.md

🔥 IGNIS - @venizia/ignis-docs

Documentation site and MCP server for the Ignis Framework

npm License TypeScript MCP

VitePress-powered documentation site and an MCP server with 11 tools that gives AI assistants real-time access to Ignis knowledge -- search docs, browse source code, and verify dependencies.

Installation • MCP Setup • Available Tools • Online Docs

Highlights

Feature
1 11 MCP Tools Search docs, browse code, verify deps from any AI assistant
2 Fuzzy Search Fuse.js-powered search across all documentation
3 VitePress Site Full-featured docs with guides, API references, and tutorials
4 CLI Binary Ships as ignis-docs-mcp for easy MCP integration

Features

  • VitePress Documentation Site -- Full-featured docs with guides, API references, tutorials, and best practices
  • MCP Server -- 11 tools for AI assistants to search docs, browse source code, and verify dependencies
  • Fuzzy Search -- Fuse.js-powered search across all documentation (title weight 0.7, content weight 0.3)
  • GitHub Integration -- Browse project files, search code, and verify dependency versions directly from AI tools
  • CLI Binary -- Ships as ignis-docs-mcp for easy integration with Claude Desktop and other MCP-compatible clients

Installation

bun add @venizia/ignis-docs
# or
npm install @venizia/ignis-docs

MCP Server Setup

Claude Desktop

Add to your Claude Desktop config (claude_desktop_config.json):

{
  "mcpServers": {
    "ignis-docs": {
      "command": "bunx",
      "args": ["@venizia/ignis-docs@latest"]
    }
  }
}

Alternatively, use npx:

{
  "mcpServers": {
    "ignis-docs": {
      "command": "npx",
      "args": ["@venizia/ignis-docs@latest"]
    }
  }
}

Claude Code

Add to your Claude Code MCP settings:

{
  "mcpServers": {
    "ignis-docs": {
      "command": "bunx",
      "args": ["@venizia/ignis-docs@latest"]
    }
  }
}

Available MCP Tools

Documentation Tools

Tool Description
searchDocs Search documentation by keyword with fuzzy matching
getDocContent Get the full content of a specific document
listDocs List all available documentation pages
listCategories List documentation categories and their structure
getDocMetadata Get metadata (title, path, category) for a document
getPackageOverview Get an overview of a specific Ignis package

GitHub Tools

Tool Description
searchCode Search the Ignis source code by keyword
listProjectFiles List files in a specific directory of the repository
viewSourceFile View the contents of a source file
verifyDependencies Check dependency versions and compatibility

Documentation Site

Development

# Start dev server
bun run docs:dev

# Build static site
bun run docs:build

# Preview production build
bun run docs:preview

Structure

wiki/
├── guides/              # Getting started, core concepts, tutorials
├── references/          # API documentation
│   ├── base/            # BaseApplication, BaseController, BaseEntity, etc.
│   ├── components/      # HealthCheck, Swagger, Auth, Mail, SocketIO, etc.
│   ├── helpers/         # Logger, Redis, Queue, Storage, Crypto, etc.
│   └── utilities/       # Parse, Date, Promise, Performance utilities
├── best-practices/      # Architecture, security, performance, code style
└── changelogs/          # Version release notes

Online Documentation

https://venizia-ai.github.io/ignis

MCP Server Development

# Development mode
bun run mcp:dev

# Build MCP server
bun run mcp:build

# Start MCP server
bun run mcp:start

# Clean + rebuild
bun run mcp:rebuild

Configuration

Setting Default Description
snippetLength 320 Max characters per search result snippet
defaultLimit 10 Default number of search results
maxLimit 50 Maximum number of search results
searchThreshold 0.4 Fuse.js fuzzy match threshold (0 = exact, 1 = loose)
repo VENIZIA-AI/ignis GitHub repository for source code tools

Related Links

License

MIT