Skip to content

An AI-powered search engine with a generative UI

docs: rename CLAUDE.md to AGENTS.md with symlink

Yoshiki Miura1efda899d87b
diff --git a/AGENTS.md b/AGENTS.md
new file mode 100644
index 00000000..58323c6e
--- /dev/null
+++ b/AGENTS.md
@@ -0,0 +1,211 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Key Commands
+
+### Development
+
+- `bun dev` - Start development server with Turbopack (http://localhost:3000)
+- `bun run build` - Create production build
+- `bun start` - Start production server
+- `bun lint` - Run ESLint for code quality checks and import sorting
+- `bun typecheck` - Run TypeScript type checking
+- `bun format` - Format code with Prettier
+- `bun format:check` - Check code formatting without modifying files
+- `bun migrate` - Run database migrations
+- `bun run test` - Run tests with Vitest (use this, NOT `bun test`)
+- `bun run test:watch` - Run tests in watch mode
+
+### Docker
+
+- `docker compose up -d` - Run the application with Docker (includes PostgreSQL 17, Redis, Morphic app, and SearXNG)
+- `docker compose down` - Stop all containers
+- `docker compose down -v` - Stop all containers and remove volumes (deletes database data)
+- `docker pull ghcr.io/miurla/morphic:latest` - Pull prebuilt Docker image
+
+#### Docker Authentication
+
+**Default Behavior**: Docker deployments run in **anonymous mode** (authentication disabled).
+
+When running with Docker Compose, `ENABLE_AUTH=false` is set by default, allowing personal use without Supabase setup. All users share a single anonymous user ID.
+
+**⚠️ Security Warning:**
+
+- Anonymous mode is **only for personal, single-user local environments**
+- All chat history is shared under one user ID
+- **NOT suitable** for multi-user or production deployments
+- Morphic Cloud deployments block `ENABLE_AUTH=false` automatically
+
+**Enabling Authentication:**
+To require Supabase authentication, set:
+
+```bash
+ENABLE_AUTH=true # or remove ENABLE_AUTH from docker-compose.yaml
+NEXT_PUBLIC_SUPABASE_URL=[your-supabase-url]
+NEXT_PUBLIC_SUPABASE_ANON_KEY=[your-supabase-anon-key]
+```
+
+**Implementation:**
+
+- Auth logic: [lib/auth/get-current-user.ts:22-40](lib/auth/get-current-user.ts#L22-L40)
+- Always warns when `ENABLE_AUTH=false` (except in tests)
+- Guards against `MORPHIC_CLOUD_DEPLOYMENT=true`
+
+## Architecture Overview
+
+### Tech Stack
+
+- **Next.js 16.0.0** with App Router, React Server Components, and Turbopack
+- **React 19.2.0** with TypeScript for type safety
+- **Vercel AI SDK 5.0.0-alpha.2** for AI streaming and GenerativeUI
+- **Supabase** for authentication and backend services
+- **PostgreSQL** with Drizzle ORM for database and chat history storage
+- **Redis** (Upstash or local) for SearXNG advanced search caching
+- **Tailwind CSS** with shadcn/ui components
+
+### Core Architecture
+
+1. **App Router Structure** (`/app`)
+ - `/api/` - Backend API routes for chat, search, and auth endpoints
+ - `/auth/` - Authentication pages (login, signup, password reset)
+ - `/search/` - Search functionality and results display
+ - `/share/` - Sharing functionality for search results
+
+2. **AI Integration** (`/lib`)
+ - `/lib/agents/` - AI agents for research and question generation
+ - `/lib/config/` - Model configuration management
+ - `/lib/streaming/` - Stream handling for AI responses
+ - `/lib/tools/` - Search and retrieval tool implementations
+ - Models configured in `public/config/models.json`
+
+3. **Database** (`/lib/db`)
+ - PostgreSQL database with Drizzle ORM
+ - Schema defined in `/lib/db/schema.ts`
+ - Migrations in `/lib/db/migrations/`
+ - Database actions in `/lib/actions/chat-db.ts`
+
+4. **Search System**
+ - Multiple providers: Tavily (default), SearXNG (self-hosted), Exa (neural), Brave (optional)
+ - Brave Search is optional; if API key is not provided, type="general" searches fall back to primary provider
+ - Video/image search support depends on configured providers (Brave provides best multimedia support)
+ - URL-specific search capabilities
+ - Configurable search depth and result limits
+
+5. **Component Organization** (`/components`)
+ - `/artifact/` - Search result and AI response display components
+ - `/sidebar/` - Chat history and navigation
+ - `/ui/` - Reusable UI components from shadcn/ui
+ - Feature-specific components (auth forms, chat interfaces)
+
+6. **State Management**
+ - Server-side state via React Server Components
+ - Client-side hooks in `/hooks/`
+ - Redis for persistent chat history
+ - Supabase for user data
+
+## Environment Configuration
+
+### Required Variables
+
+```bash
+OPENAI_API_KEY= # Default AI provider
+TAVILY_API_KEY= # Default search provider
+DATABASE_URL= # PostgreSQL connection string
+```
+
+### Optional Features
+
+- Chat history: Set `ENABLE_SAVE_CHAT_HISTORY=true` and configure Redis
+- Alternative AI providers: Add corresponding API keys (ANTHROPIC_API_KEY, GOOGLE_GENERATIVE_AI_API_KEY, etc.)
+- Alternative search: Configure SEARCH_API and provider-specific settings
+- Sharing: Set `NEXT_PUBLIC_ENABLE_SHARE=true`
+
+## Key Development Patterns
+
+1. **AI Streaming**: Uses Vercel AI SDK's streaming capabilities for real-time responses
+2. **GenerativeUI**: Dynamic UI components generated based on AI responses
+3. **Type Safety**: Strict TypeScript configuration with comprehensive type definitions in `/lib/types/`
+4. **Schema Validation**: Zod schemas in `/lib/schema/` for data validation
+5. **Error Handling**: Comprehensive error boundaries and fallback UI components
+
+## Testing Approach
+
+- Unit and integration tests with Vitest
+- Test files located alongside source files with `.test.ts` or `.test.tsx` extension
+- **Run `bun run test` to execute all tests** (NOT `bun test` - that uses Bun's built-in test runner which lacks Vitest features)
+- Run `bun run test:watch` for development with watch mode
+- CI automatically runs `bun run test` to ensure all tests pass
+
+## Pre-PR Requirements
+
+Before creating a pull request, you MUST ensure all of the following checks pass:
+
+1. **Linting**: Run `bun lint` and fix all ESLint errors and warnings (includes import sorting)
+2. **Type checking**: Run `bun typecheck` to ensure no TypeScript errors
+3. **Formatting**: Run `bun format:check` to verify code formatting (or `bun format` to auto-fix)
+4. **Build**: Run `bun run build` to ensure the application builds successfully
+5. **Tests**: Run `bun run test` to ensure all tests pass
+
+These checks are enforced in CI/CD and PRs will fail if any of these steps don't pass.
+
+Note: Import sorting is handled by ESLint using `eslint-plugin-simple-import-sort`. Run `bun lint --fix` to automatically sort imports according to the configured order.
+
+## Model Configuration
+
+Models are defined in `public/config/models.json` with:
+
+- `id`: Model identifier
+- `provider`: Display name
+- `providerId`: Provider key for API routing
+- `enabled`: Toggle availability
+- `toolCallType`: "native" or "manual" for function calling
+- `toolCallModel`: Optional override for tool calls
+
+## Database Management
+
+- Run `bun migrate` to apply database migrations
+- Migrations are located in `/drizzle/` directory
+- Schema changes should be made in `/lib/db/schema.ts`
+- Use Drizzle Kit for generating migrations
+
+## MCP (Model Context Protocol) Integration
+
+This project supports MCP for enhanced AI assistant integration with Next.js 16.
+
+### Built-in Next.js MCP Server
+
+Next.js 16 provides a built-in MCP server at `http://localhost:3000/_next/mcp` when the dev server is running.
+
+**Available Tools:**
+
+- `get_project_metadata` - Get project path and dev server URL
+- `get_errors` - Retrieve current error state (global errors, runtime errors, build errors)
+- `get_page_metadata` - Get runtime metadata about current page renders
+- `get_logs` - Access Next.js development log file path
+- `get_server_action_by_id` - Locate Server Actions by ID
+
+**Usage:**
+
+1. Start the dev server: `bun dev`
+2. MCP endpoint is automatically available at `/_next/mcp`
+3. AI assistants can query real-time app state, errors, and logs
+
+### Next DevTools MCP (External)
+
+The project includes `.mcp.json` configuration for the Next DevTools MCP package, which provides:
+
+- Next.js knowledge base access
+- Automated migration tools
+- Cache optimization guides
+- Browser testing capabilities
+
+**Setup:**
+The `.mcp.json` file in the project root enables team-wide MCP tool sharing. AI assistants like Claude Code will prompt for approval before using project-scoped servers.
+
+**Benefits:**
+
+- Real-time access to application internal state
+- Improved debugging and error diagnostics
+- Context-aware code suggestions
+- Live application state querying
diff --git a/CLAUDE.md b/CLAUDE.md
deleted file mode 100644
index 58323c6e..00000000
--- a/CLAUDE.md
+++ /dev/null
@@ -1,211 +0,0 @@
-# CLAUDE.md
-
-This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
-
-## Key Commands
-
-### Development
-
-- `bun dev` - Start development server with Turbopack (http://localhost:3000)
-- `bun run build` - Create production build
-- `bun start` - Start production server
-- `bun lint` - Run ESLint for code quality checks and import sorting
-- `bun typecheck` - Run TypeScript type checking
-- `bun format` - Format code with Prettier
-- `bun format:check` - Check code formatting without modifying files
-- `bun migrate` - Run database migrations
-- `bun run test` - Run tests with Vitest (use this, NOT `bun test`)
-- `bun run test:watch` - Run tests in watch mode
-
-### Docker
-
-- `docker compose up -d` - Run the application with Docker (includes PostgreSQL 17, Redis, Morphic app, and SearXNG)
-- `docker compose down` - Stop all containers
-- `docker compose down -v` - Stop all containers and remove volumes (deletes database data)
-- `docker pull ghcr.io/miurla/morphic:latest` - Pull prebuilt Docker image
-
-#### Docker Authentication
-
-**Default Behavior**: Docker deployments run in **anonymous mode** (authentication disabled).
-
-When running with Docker Compose, `ENABLE_AUTH=false` is set by default, allowing personal use without Supabase setup. All users share a single anonymous user ID.
-
-**⚠️ Security Warning:**
-
-- Anonymous mode is **only for personal, single-user local environments**
-- All chat history is shared under one user ID
-- **NOT suitable** for multi-user or production deployments
-- Morphic Cloud deployments block `ENABLE_AUTH=false` automatically
-
-**Enabling Authentication:**
-To require Supabase authentication, set:
-
-```bash
-ENABLE_AUTH=true # or remove ENABLE_AUTH from docker-compose.yaml
-NEXT_PUBLIC_SUPABASE_URL=[your-supabase-url]
-NEXT_PUBLIC_SUPABASE_ANON_KEY=[your-supabase-anon-key]
-```
-
-**Implementation:**
-
-- Auth logic: [lib/auth/get-current-user.ts:22-40](lib/auth/get-current-user.ts#L22-L40)
-- Always warns when `ENABLE_AUTH=false` (except in tests)
-- Guards against `MORPHIC_CLOUD_DEPLOYMENT=true`
-
-## Architecture Overview
-
-### Tech Stack
-
-- **Next.js 16.0.0** with App Router, React Server Components, and Turbopack
-- **React 19.2.0** with TypeScript for type safety
-- **Vercel AI SDK 5.0.0-alpha.2** for AI streaming and GenerativeUI
-- **Supabase** for authentication and backend services
-- **PostgreSQL** with Drizzle ORM for database and chat history storage
-- **Redis** (Upstash or local) for SearXNG advanced search caching
-- **Tailwind CSS** with shadcn/ui components
-
-### Core Architecture
-
-1. **App Router Structure** (`/app`)
- - `/api/` - Backend API routes for chat, search, and auth endpoints
- - `/auth/` - Authentication pages (login, signup, password reset)
- - `/search/` - Search functionality and results display
- - `/share/` - Sharing functionality for search results
-
-2. **AI Integration** (`/lib`)
- - `/lib/agents/` - AI agents for research and question generation
- - `/lib/config/` - Model configuration management
- - `/lib/streaming/` - Stream handling for AI responses
- - `/lib/tools/` - Search and retrieval tool implementations
- - Models configured in `public/config/models.json`
-
-3. **Database** (`/lib/db`)
- - PostgreSQL database with Drizzle ORM
- - Schema defined in `/lib/db/schema.ts`
- - Migrations in `/lib/db/migrations/`
- - Database actions in `/lib/actions/chat-db.ts`
-
-4. **Search System**
- - Multiple providers: Tavily (default), SearXNG (self-hosted), Exa (neural), Brave (optional)
- - Brave Search is optional; if API key is not provided, type="general" searches fall back to primary provider
- - Video/image search support depends on configured providers (Brave provides best multimedia support)
- - URL-specific search capabilities
- - Configurable search depth and result limits
-
-5. **Component Organization** (`/components`)
- - `/artifact/` - Search result and AI response display components
- - `/sidebar/` - Chat history and navigation
- - `/ui/` - Reusable UI components from shadcn/ui
- - Feature-specific components (auth forms, chat interfaces)
-
-6. **State Management**
- - Server-side state via React Server Components
- - Client-side hooks in `/hooks/`
- - Redis for persistent chat history
- - Supabase for user data
-
-## Environment Configuration
-
-### Required Variables
-
-```bash
-OPENAI_API_KEY= # Default AI provider
-TAVILY_API_KEY= # Default search provider
-DATABASE_URL= # PostgreSQL connection string
-```
-
-### Optional Features
-
-- Chat history: Set `ENABLE_SAVE_CHAT_HISTORY=true` and configure Redis
-- Alternative AI providers: Add corresponding API keys (ANTHROPIC_API_KEY, GOOGLE_GENERATIVE_AI_API_KEY, etc.)
-- Alternative search: Configure SEARCH_API and provider-specific settings
-- Sharing: Set `NEXT_PUBLIC_ENABLE_SHARE=true`
-
-## Key Development Patterns
-
-1. **AI Streaming**: Uses Vercel AI SDK's streaming capabilities for real-time responses
-2. **GenerativeUI**: Dynamic UI components generated based on AI responses
-3. **Type Safety**: Strict TypeScript configuration with comprehensive type definitions in `/lib/types/`
-4. **Schema Validation**: Zod schemas in `/lib/schema/` for data validation
-5. **Error Handling**: Comprehensive error boundaries and fallback UI components
-
-## Testing Approach
-
-- Unit and integration tests with Vitest
-- Test files located alongside source files with `.test.ts` or `.test.tsx` extension
-- **Run `bun run test` to execute all tests** (NOT `bun test` - that uses Bun's built-in test runner which lacks Vitest features)
-- Run `bun run test:watch` for development with watch mode
-- CI automatically runs `bun run test` to ensure all tests pass
-
-## Pre-PR Requirements
-
-Before creating a pull request, you MUST ensure all of the following checks pass:
-
-1. **Linting**: Run `bun lint` and fix all ESLint errors and warnings (includes import sorting)
-2. **Type checking**: Run `bun typecheck` to ensure no TypeScript errors
-3. **Formatting**: Run `bun format:check` to verify code formatting (or `bun format` to auto-fix)
-4. **Build**: Run `bun run build` to ensure the application builds successfully
-5. **Tests**: Run `bun run test` to ensure all tests pass
-
-These checks are enforced in CI/CD and PRs will fail if any of these steps don't pass.
-
-Note: Import sorting is handled by ESLint using `eslint-plugin-simple-import-sort`. Run `bun lint --fix` to automatically sort imports according to the configured order.
-
-## Model Configuration
-
-Models are defined in `public/config/models.json` with:
-
-- `id`: Model identifier
-- `provider`: Display name
-- `providerId`: Provider key for API routing
-- `enabled`: Toggle availability
-- `toolCallType`: "native" or "manual" for function calling
-- `toolCallModel`: Optional override for tool calls
-
-## Database Management
-
-- Run `bun migrate` to apply database migrations
-- Migrations are located in `/drizzle/` directory
-- Schema changes should be made in `/lib/db/schema.ts`
-- Use Drizzle Kit for generating migrations
-
-## MCP (Model Context Protocol) Integration
-
-This project supports MCP for enhanced AI assistant integration with Next.js 16.
-
-### Built-in Next.js MCP Server
-
-Next.js 16 provides a built-in MCP server at `http://localhost:3000/_next/mcp` when the dev server is running.
-
-**Available Tools:**
-
-- `get_project_metadata` - Get project path and dev server URL
-- `get_errors` - Retrieve current error state (global errors, runtime errors, build errors)
-- `get_page_metadata` - Get runtime metadata about current page renders
-- `get_logs` - Access Next.js development log file path
-- `get_server_action_by_id` - Locate Server Actions by ID
-
-**Usage:**
-
-1. Start the dev server: `bun dev`
-2. MCP endpoint is automatically available at `/_next/mcp`
-3. AI assistants can query real-time app state, errors, and logs
-
-### Next DevTools MCP (External)
-
-The project includes `.mcp.json` configuration for the Next DevTools MCP package, which provides:
-
-- Next.js knowledge base access
-- Automated migration tools
-- Cache optimization guides
-- Browser testing capabilities
-
-**Setup:**
-The `.mcp.json` file in the project root enables team-wide MCP tool sharing. AI assistants like Claude Code will prompt for approval before using project-scoped servers.
-
-**Benefits:**
-
-- Real-time access to application internal state
-- Improved debugging and error diagnostics
-- Context-aware code suggestions
-- Live application state querying
diff --git a/CLAUDE.md b/CLAUDE.md
new file mode 120000
index 00000000..47dc3e3d
--- /dev/null
+++ b/CLAUDE.md
@@ -0,0 +1 @@
+AGENTS.md
\ No newline at end of file