• Features

RAGent - RAG System Builder for Markdown Documents

日本語版 (Japanese) / 日本語 README

RAGent is a CLI tool for building a RAG (Retrieval-Augmented Generation) system from markdown documents using hybrid search capabilities (BM25 + vector search) with Amazon S3 Vectors and OpenSearch.

Table of Contents

• Features
• Slack Search Integration
• Embedding-Agnostic RAG
• Environment Variable Setup Guide
• Architecture Overview
• Prerequisites
• Required Environment Variables
• Installation
• Releases
• Commands
  • vectorize - Vectorization and S3 Storage
  • query - Semantic Search
  • list - List Vectors
  • chat - Interactive RAG Chat
  • slack-bot - Slack Bot for RAG Search
  • mcp-server - MCP Server for Claude Desktop Integration
  • webui - Web UI for Vectorization Monitoring
• Development
• Typical Workflow
• Troubleshooting
• AWS Secrets Manager Integration
• OpenSearch RAG Configuration
• Automated Setup (setup.sh)
• License
• MCP Server Integration
• Contributing

Features

• Vectorization: Convert source files (markdown, CSV, and PDF) from local directories, S3, or GitHub repositories to embeddings using Amazon Bedrock
• GitHub Data Source: Clone GitHub repositories and vectorize their markdown/CSV files with auto-generated metadata
• S3 Vector Integration: Store generated vectors in Amazon S3 Vectors
• Hybrid Search: Combined BM25 + vector search using OpenSearch
• Slack Search Integration: Blend document results with Slack conversations via an iterative enrichment pipeline
• Semantic Search: Semantic similarity search using S3 Vector Index
• Interactive RAG Chat: Chat interface with context-aware responses
• Vector Management: List vectors stored in S3
• Embedding-Agnostic RAG: Optional search path that answers directly from Slack without requiring pre-built vectors
• MCP Server: Model Context Protocol server for Claude Desktop integration
• OIDC Authentication: OpenID Connect authentication with multiple providers
• IP-based Security: IP address-based access control with configurable bypass ranges and audit logging
• Dual Transport: HTTP and Server-Sent Events (SSE) transport support
• AWS Secrets Manager Integration: Automatic secret injection as environment variable fallback

Slack Search Integration

Slack search extends every retrieval workflow by streaming recent conversations, threads, and channel timelines directly from Slack’s Web API. When SLACK_SEARCH_ENABLED=true, the following behavior is enabled automatically:

• query exposes --enable-slack-search flag to opt in per request.
• chat surfaces Slack context in addition to documents without requiring extra flags.
• slack-bot responds with combined document + Slack answers inside Block Kit messages.
• mcp-server adds enable_slack_search parameter to the hybrid_search tool.

Each Slack lookup performs iterative query refinement, merges timeline context from threads, and runs a sufficiency check before the final answer is generated. Results include permalinks so operators can pivot back to the original conversation instantly.

Slack URL Reference

You can include Slack message URLs directly in your queries. RA

... View full README on GitHub