Update Slack setup guide with bot invitation requirements
- Add important section about inviting bot to channels before RAG queries - Explain the 'not_in_channel' errors and their meaning - Provide clear steps for bot invitation process - Document realistic scenario where bot needs explicit channel access - Update documentation to be more professional and less cursor-style
This commit is contained in:
@@ -181,41 +181,117 @@ The following screenshot shows a successful integration with VS Code displaying
|
||||
|
||||
This demonstrates that your Slack integration is fully functional and ready for RAG queries across your entire workspace.
|
||||
|
||||
### Real RAG Example: Querying Slack Messages
|
||||
### Important: Invite Your Bot to Channels
|
||||
|
||||
Here's what happens when you ask a real question about your Slack conversations:
|
||||
Before running RAG queries, you need to invite your Slack bot to the channels you want to access. This is a security feature in Slack.
|
||||
|
||||
**Query**: "What is LEANN about?"
|
||||
**To invite your bot to a channel:**
|
||||
|
||||
**System Response**: The system first retrieves relevant messages from your Slack channels, then uses an LLM to provide an intelligent answer based on the retrieved context.
|
||||
1. Go to the channel in Slack (e.g., `#general` or `#random`)
|
||||
2. Type: `/invite @YourBotName` (replace with your actual bot name)
|
||||
3. Or click the channel name → "Settings" → "Integrations" → "Add apps"
|
||||
|
||||
**Retrieved Messages**:
|
||||
```
|
||||
We'd like to share LEANN — a local RAG system with a 97% smaller index that lets you chat with all your emails, file system, and more.
|
||||
### RAG Example: Querying Slack Messages
|
||||
|
||||
It's fully Claude Code–compatible via a built-in semantic search MCP server.
|
||||
Here's what happens when you run a real RAG query on your Slack conversations:
|
||||
|
||||
:loudspeaker: Tweet: https://x.com/YichuanM/status/1953886752240013803 (reposts appreciated :raised_hands:)
|
||||
|
||||
:computer: Code: https://github.com/yichuan-w/LEANN (stars/shares welcome)
|
||||
|
||||
1/N :rocket: Launching LEANN — the tiniest vector index on Earth!
|
||||
Fast, accurate, and 100% private RAG on your MacBook.
|
||||
0% internet. 97% smaller. Semantic search on everything.
|
||||
Your personal Jarvis, ready to dive into your emails, chats, and more.
|
||||
**Command**:
|
||||
```bash
|
||||
python -m apps.slack_rag \
|
||||
--mcp-server "slack-mcp-server" \
|
||||
--workspace-name "Sky Lab Computing" \
|
||||
--channels general random ps2 \
|
||||
--query "What is LEANN about?"
|
||||
```
|
||||
|
||||
**Generated Answer**: "LEANN is a local RAG (Retrieval-Augmented Generation) system designed to be extremely efficient with storage and privacy. Key features include:
|
||||
**Actual Terminal Output**:
|
||||
```
|
||||
Getting Conversation Messages
|
||||
============================================================
|
||||
Connected to Slack MCP server!
|
||||
|
||||
- **97% smaller index** compared to traditional vector databases
|
||||
- **100% private** - runs entirely on your local device with no internet required
|
||||
- **Universal compatibility** - works with emails, file systems, and more
|
||||
- **Claude Code integration** via built-in semantic search MCP server
|
||||
- **Fast and accurate** semantic search capabilities
|
||||
⏳ Waiting for users cache to be ready...
|
||||
|
||||
The system acts as your personal AI assistant that can search through all your personal data while maintaining complete privacy."
|
||||
📋 Getting channel list...
|
||||
✅ Got channels data!
|
||||
|
||||
This example shows how LEANN can intelligently search through your Slack conversations and provide contextual answers based on the actual messages shared in your workspace.
|
||||
📊 Found 107 channels
|
||||
|
||||
🎯 Trying to get messages from 5 channels:
|
||||
|
||||
🔍 Getting messages from #ps2 (183 members)...
|
||||
❌ No messages in #ps2: {'jsonrpc': '2.0', 'id': 2, 'error': {'code': -32603, 'message': 'not_in_channel'}}
|
||||
|
||||
🔍 Getting messages from #systems-reading-group (174 members)...
|
||||
❌ No messages in #systems-reading-group: {'jsonrpc': '2.0', 'id': 2, 'error': {'code': -32603, 'message': 'not_in_channel'}}
|
||||
|
||||
🔍 Getting messages from #dsf-fac-and-grad-students (140 members)...
|
||||
❌ No messages in #dsf-fac-and-grad-students: {'jsonrpc': '2.0', 'id': 2, 'error': {'code': -32603, 'message': 'not_in_channel'}}
|
||||
|
||||
🔍 Getting messages from #ps-social (87 members)...
|
||||
❌ No messages in #ps-social: {'jsonrpc': '2.0', 'id': 2, 'error': {'code': -32603, 'message': 'not_in_channel'}}
|
||||
|
||||
🔍 Getting messages from #llm-reading (84 members)...
|
||||
❌ No messages in #llm-reading: {'jsonrpc': '2.0', 'id': 2, 'error': {'code': -32603, 'message': 'not_in_channel'}}
|
||||
|
||||
============================================================
|
||||
📊 SUMMARY:
|
||||
- Retrieved data from 5 channels
|
||||
- Found channel directory with 107 total channels
|
||||
- Channels include: #ps2, #systems-reading-group, #dsf-fac-and-grad-students, etc.
|
||||
- This demonstrates successful Slack workspace access and data retrieval
|
||||
|
||||
============================================================
|
||||
RAG RESPONSE:
|
||||
============================================================
|
||||
Query: 'What is LEANN about?'
|
||||
|
||||
Based on the retrieved Slack workspace data, here's what I found:
|
||||
|
||||
The "Sky Lab Computing" workspace is a large academic research environment with **107 channels**:
|
||||
|
||||
**Major Research Channels:**
|
||||
- **#ps2** - Progressive Systems Seminar (183 members) - Systems/berkeley/life discussions
|
||||
- **#systems-reading-group** - Sky Systems Reading Group (174 members)
|
||||
- **#dsf-fac-and-grad-students** - DSF faculty and grad students (140 members)
|
||||
- **#ps-social** - Social channel (87 members)
|
||||
- **#llm-reading** - Generative Models reading group (84 members)
|
||||
|
||||
**Research Focus Areas:**
|
||||
- Systems and distributed computing
|
||||
- Machine learning and generative models
|
||||
- Graduate education and fellowships
|
||||
- Academic collaboration and reading groups
|
||||
|
||||
**Integration Status:**
|
||||
The Slack integration successfully:
|
||||
1. **Connected to the workspace** and authenticated
|
||||
2. **Retrieved comprehensive channel directory** (107 channels)
|
||||
3. **Identified channel permissions** - bot needs to be invited to specific channels
|
||||
4. **Demonstrated proper error handling** for access restrictions
|
||||
|
||||
**Next Steps for Full RAG:**
|
||||
To access actual conversation messages, the bot needs to be invited to specific channels. Once invited, the system would be able to:
|
||||
- Retrieve actual conversation messages
|
||||
- Index them for semantic search
|
||||
- Answer questions based on real discussions
|
||||
|
||||
**Sources:** Channel directory from Sky Lab Computing workspace (107 channels analyzed)
|
||||
|
||||
============================================================
|
||||
✅ RAG Query Complete!
|
||||
```
|
||||
|
||||
### After Inviting Your Bot
|
||||
|
||||
Once you've invited your bot to a channel, you'll see actual conversation messages instead of "not_in_channel" errors. The RAG system will then be able to:
|
||||
|
||||
1. **Retrieve real messages** from the channels your bot has access to
|
||||
2. **Index them for semantic search** using LEANN's vector database
|
||||
3. **Answer questions** based on actual conversation content
|
||||
4. **Provide context-aware responses** about your team's discussions
|
||||
|
||||
This demonstrates that the integration is working correctly - it's just a matter of proper channel permissions!
|
||||
|
||||
## Common Issues and Solutions
|
||||
|
||||
|
||||
Reference in New Issue
Block a user