Skip to content

Commit ed57739

Browse files
committed
Revise README.md and mcp/README.md to enhance clarity and accuracy. Update main features section with concise descriptions, improve batch upload instructions, and replace references to Streamlit UI with Next.js UI. Add a quick start guide for easier setup and streamline commands for building and running the application.
1 parent 4acbeae commit ed57739

File tree

2 files changed

+45
-50
lines changed

2 files changed

+45
-50
lines changed

README.md

Lines changed: 41 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -37,43 +37,30 @@ This project was inspired by [langchain-ai/langconnect](https://github.com/langc
3737
## ✨ Main Features
3838

3939
### 📚 **Collection Management**
40-
- Create, read, update, and delete document collections
41-
- Organize documents with custom metadata
42-
- Real-time statistics for documents and chunks
43-
- Bulk operations support
40+
- CRUD operations with custom metadata support
41+
- Real-time statistics and bulk operations
4442

4543
### 📄 **Document Management**
4644
- Multi-format support (PDF, TXT, MD, DOCX, HTML)
47-
- Batch upload capabilities with drag-and-drop interface
4845
- Automatic text extraction and chunking
49-
- Document-level and chunk-level management
50-
- Metadata customization for enhanced searchability
51-
52-
### 🔍 **Advanced Search Capabilities**
53-
- **Semantic Search**: Vector similarity search using OpenAI embeddings
54-
- **Keyword Search**: Traditional full-text search
55-
- **Hybrid Search**: Combines semantic and keyword search for best results
56-
- Metadata filtering with JSON support
57-
- Real-time search results with relevance scores
58-
59-
### 🔐 **Authentication & Security**
60-
- Supabase integration for secure user authentication
61-
- JWT-based API access
62-
- Session persistence
46+
- Drag-and-drop batch upload
47+
48+
### 🔍 **Advanced Search**
49+
- **Semantic**: Vector similarity search with OpenAI embeddings
50+
- **Keyword**: PostgreSQL full-text search
51+
- **Hybrid**: Combined search with configurable weights
52+
53+
### 🔐 **Authentication**
54+
- Supabase JWT authentication
6355
- Role-based access control
6456

65-
### 🤖 **MCP (Model Context Protocol) Integration**
66-
- Direct integration with AI assistants (Claude Desktop, Cursor)
67-
- 9 comprehensive tools for document management
68-
- Both stdio and SSE transport support
69-
- Automated configuration generation
57+
### 🤖 **MCP Integration**
58+
- 9+ tools for AI assistants (Claude, Cursor)
59+
- stdio and SSE transport support
7060

71-
### 🎨 **Modern UI/UX**
72-
- Responsive design with Tailwind CSS
73-
- Dark/Light theme support
74-
- Multi-language support (English, Korean)
75-
- Real-time updates and notifications
76-
- Interactive API testing interface
61+
### 🎨 **Modern UI**
62+
- Next.js with Tailwind CSS
63+
- Dark/Light themes, Multi-language (EN/KO)
7764

7865
## 🏗️ Architecture
7966

@@ -92,6 +79,21 @@ This project was inspired by [langchain-ai/langconnect](https://github.com/langc
9279

9380
## 🚀 Getting Started
9481

82+
### Quick Start
83+
84+
```bash
85+
# Clone and setup
86+
git clone https://github.com/teddynote-lab/langconnect-client.git
87+
cd langconnect-client
88+
cp .env.example .env
89+
90+
# Edit .env with your credentials, then:
91+
make build # Build Docker images
92+
make up # Start all services
93+
make mcp # Create MCP configuration
94+
make down # Stop services
95+
```
96+
9597
### Prerequisites
9698

9799
- Docker and Docker Compose
@@ -124,28 +126,18 @@ This project was inspired by [langchain-ai/langconnect](https://github.com/langc
124126
```env
125127
SUPABASE_URL=https://your-project.supabase.co
126128
SUPABASE_KEY=your-anon-public-key
127-
128-
# Also update these for Next.js
129-
NEXTAUTH_SECRET=your-secret-key-here
130-
NEXTAUTH_URL=http://localhost:3000
131-
NEXT_PUBLIC_API_URL=http://localhost:8080
132129
```
133130

134131
4. **Build the application**
135132
```bash
136-
./install.sh
133+
make build
137134
```
138-
139-
This script will:
140-
- Install frontend dependencies using pnpm
141-
- Build the Next.js application
142-
- Build all Docker images
143135

144136
### Running the Application
145137

146138
1. **Start all services**
147139
```bash
148-
docker compose up -d
140+
make up
149141
```
150142

151143
2. **Access the services**
@@ -155,7 +147,12 @@ This project was inspired by [langchain-ai/langconnect](https://github.com/langc
155147

156148
3. **Stop services**
157149
```bash
158-
docker compose down
150+
make down
151+
```
152+
153+
4. **View logs**
154+
```bash
155+
make logs
159156
```
160157

161158
## 🤖 MCP Integration
@@ -164,7 +161,7 @@ This project was inspired by [langchain-ai/langconnect](https://github.com/langc
164161

165162
1. **Generate MCP configuration**
166163
```bash
167-
uv run python mcp/create_mcp_json.py
164+
make mcp
168165
```
169166

170167
This command will:
@@ -267,8 +264,6 @@ In the Inspector:
267264

268265
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
269266

270-
---
271-
272267
<div align="center">
273268
Made with ❤️ by <a href="https://github.com/teddynote-lab">TeddyNote LAB</a>
274269
</div>

mcp/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,12 @@ Enter your email and password when prompted. The script will:
2121
- Test the token
2222
- Display the access token for you to copy
2323

24-
#### Option 2: From the Streamlit UI
24+
#### Option 2: From the Next.js UI
2525

26-
1. **Sign in to the Streamlit UI** at http://localhost:8501
26+
1. **Sign in to the Next.js UI** at http://localhost:3000
2727
2. **Open Developer Tools** in your browser (F12)
2828
3. **Go to the Application/Storage tab**
29-
4. **Find Session Storage** for localhost:8501
29+
4. **Find Session Storage** for localhost:3000
3030
5. **Look for the `access_token` key**
3131
6. **Copy the JWT token value**
3232

@@ -69,7 +69,7 @@ SUPABASE_JWT_SECRET=YOUR_JWT_TOKEN_HERE
6969

7070
Supabase JWT tokens expire after a certain period (typically 1 hour). When your token expires:
7171

72-
1. Sign in again through the Streamlit UI
72+
1. Sign in again through the Next.js UI
7373
2. Get the new access token
7474
3. Update your configuration with the new token
7575

0 commit comments

Comments
 (0)