R2R FastMCP Documentation

Полная русскоязычная документация по ключевым технологиям для AI-разработки: R2R, FastMCP и Claude Code

📚 О проекте

Этот репозиторий содержит детальную документацию на русском языке для трех технологий, которые вместе формируют мощный стек для AI-разработки:

🔷 R2R - RAG to Riches

Production-ready система retrieval-augmented generation с:

• Vector Search (семантический поиск)
• Full-Text Search (полнотекстовый поиск)
• Knowledge Graphs (графы знаний)
• Agentic RAG (агентные системы)
• Multi-User Support (коллекции, аутентификация)

Версия: v3.x Документация: docs/r2r/README.md

🔷 FastMCP - Model Context Protocol Server

Pythonic фреймворк для создания серверов и клиентов MCP:

• Декораторы для быстрого создания tools, resources, prompts
• Context injection и dependency management
• HTTP и Stdio транспорты
• JWT и OAuth аутентификация
• Middleware и error handling
• FastAPI и OpenAPI интеграция

Версия: 2.x Документация: docs/fastmcp/README.md

🔷 Claude Code - AI-Powered CLI

Официальный инструмент от Anthropic для агентного программирования:

• Субагенты для специализированных задач
• Hooks и кастомизация workflow
• MCP Integration для расширения возможностей
• Skills и Agents
• Plugins и Marketplaces
• GitHub Integration

Версия: 1.0.58+ Документация: docs/claude_code/README.md

---

⚙️ R2R Integration

Репозиторий включает полную интеграцию с R2R v3 API:

Modular CLI (8 команд, 48 подкоманд)

.claude/scripts/r2r search "query" --limit 5
.claude/scripts/r2r rag "question" --show-sources
.claude/scripts/r2r agent "query" --mode research --thinking
.claude/scripts/r2r docs list -l 10 -q
.claude/scripts/r2r collections create -n "Name"
.claude/scripts/r2r conversation list
.claude/scripts/r2r graph entities <id> -l 50
.claude/scripts/r2r analytics system

Slash Commands (15)

• R2R Core: /r2r-search, /r2r-rag, /r2r-agent
• R2R Management: /r2r-collections, /r2r-upload, /r2r
• R2R Helpers: /r2r-examples, /r2r-workflows, /r2r-quick
• Claude Code: /cc, /cc-hooks, /cc-commands, /cc-mcp, /cc-subagents, /cc-setup

Helper Scripts

• examples.sh - 50+ interactive examples
• workflows.sh - 5 automated workflows
• quick.sh - 10 quick tasks
• aliases.sh - shell shortcuts

Agents & Skills

• 3 специализированных агента
• 3 skills для R2R

Подробнее: .claude/README.md

---

🚀 Быстрый старт

Навигация по документации

# Полная документация R2R (8 разделов)
docs/r2r/README.md

# Полная документация FastMCP (8 разделов)
docs/fastmcp/README.md

# Полная документация Claude Code (13 разделов)
docs/claude_code/README.md

R2R Quick Start

# Поиск в knowledge base
.claude/scripts/r2r search "R2R documentation" --limit 5

# RAG запрос
.claude/scripts/r2r rag "Как настроить hybrid search?"

# Agent conversation
.claude/scripts/r2r agent "Explain transformers" --thinking

# Через slash commands
/r2r-search "query" 5
/r2r-rag "question"
/r2r-agent "message" research

Quick Reference

Для работы с репозиторием через Claude Code доступен CLAUDE.md - справочник с:

• Quick Reference для всех трех технологий
• API endpoints, SDK примеры, конфигурации
• Паттерны интеграции технологий
• Команды и workflow

---

📖 Содержание документации

R2R Documentation (8 разделов)

1. Installation and Setup - Docker, Python/JS SDK, GCP deployment
2. Document Management - Ingestion, metadata, lifecycle
3. Search and RAG - Vector, full-text, hybrid search, RAG queries
4. Knowledge Graphs - Entities, relationships, communities
5. Collections - Organization, access control, permissions
6. Authentication and Users - JWT, API keys, RBAC
7. Configuration - r2r.toml, environment variables, tuning
8. Agent - RAG mode, Research mode, tools, conversations

FastMCP Documentation (8 разделов)

1. Introduction - Что такое FastMCP, установка, quick start
2. Tools - Создание и настройка инструментов
3. Resources & Prompts - Ресурсы и промпты
4. Client & Connection - Транспорты, подключение
5. Authentication - JWT, OAuth, security
6. Deployment & Configuration - Docker, K8s, Cloud
7. Middleware & Error Handling - Middleware, exceptions
8. FastAPI & OpenAPI Integration - Интеграция с API

Claude Code Documentation (13 разделов)

1. Overview - Что такое Claude Code, возможности
2. Installation - Установка, аутентификация
3. Core Features - Основные возможности, CLAUDE.md
4. Commands - CLI, Slash Commands
5. Hooks - Кастомизация workflow
6. Subagents - 9 типов субагентов
7. MCP Integration - Model Context Protocol
8. Skills & Agents - Специализированные агенты
9. Plugins - Расширения, Marketplaces
10. Settings - Конфигурация, permissions
11. GitHub Integration - Git, PR Review
12. Security - Sandbox, Enterprise
13. Troubleshooting - Debug, Doctor

---

🔗 Интеграции

R2R API Integration

Полная интеграция с R2R v3 через модульный bash CLI:

• GNU-style флаги (--limit, -l, --quiet, -q)
• Три режима вывода: default, quiet, JSON
• 8 команд с 48 подкомандами
• Slash commands для Claude Code

Claude Code Integration

• 15 slash commands для быстрого доступа
• 3 специализированных агента
• Hooks для автоматизации
• CLAUDE.md для контекста проекта

Подробнее в .claude/README.md

---

🛠️ Для разработчиков

Структура репозитория

r2r-fastmcp/
├── docs/
│   ├── r2r/              # R2R v3 документация (8 разделов)
│   ├── fastmcp/          # FastMCP 2.x документация (8 разделов)
│   └── claude_code/      # Claude Code документация (13 разделов)
├── .claude/              # Claude Code интеграция
│   ├── commands/         # 15 slash commands
│   ├── scripts/          # Модульный R2R CLI (8 команд, 48 подкоманд)
│   ├── agents/           # 3 специализированных агента
│   ├── skills/           # 3 R2R skills
│   ├── hooks/            # Lifecycle hooks
│   └── config/           # .env конфигурация
├── CLAUDE.md             # Project memory для Claude Code
└── README.md             # Этот файл

Работа с документацией

# Поиск по содержимому
rg "search term" docs/

# Поиск файлов
fd -e md . docs/

# Статистика
fd -e md . docs | wc -l  # Количество файлов

Стандарты

• Язык: Русский (текст) + English (код, термины, API)
• Формат: Markdown (GitHub Flavored)
• Стиль: Эмодзи в заголовках, практические примеры
• Коммиты: type(scope): description (без подписей, одна строка)

---

📝 Вклад в проект

Если вы нашли ошибку или хотите улучшить документацию:

1. Fork репозитория
2. Создайте feature branch (git checkout -b docs/improve-section)
3. Внесите изменения
4. Commit (git commit -m "docs(r2r): add search examples")
5. Push (git push origin docs/improve-section)
6. Создайте Pull Request

---

📚 Полезные ссылки

Официальные ресурсы

R2R:

• GitHub
• Documentation
• Python SDK
• JavaScript SDK

FastMCP:

• GitHub
• Documentation
• FastMCP Cloud

Claude Code:

• Official Documentation
• GitHub Repository
• SDK Documentation

Сообщества

• MCP Protocol
• Anthropic Discord
• LiteLLM Documentation

---

📄 Лицензия

MIT License - см. LICENSE для деталей.

Документация создана на основе официальных источников и дополнена практическими примерами.

---

🎯 Статус

• R2R Documentation: ✅ Полная (8/8 разделов)
• FastMCP Documentation: ✅ Полная (8/8 разделов)
• Claude Code Documentation: ✅ Полная (13/13 разделов)
• CLAUDE.md Quick Reference: ✅ Готов

Последнее обновление: Ноябрь 2025

---

Автор: evgenygurin Репозиторий: github.com/evgenygurin/r2r-fastmcp