weaviate-setup
Skill23 starsChanged 38 days agoMITView on GitHub
Interactive onboarding for the Weaviate knowledge store. Guides users through choosing a deployment type (Cloud, Local Docker, or Custom), setting environment variables, and verifying the connection. Activates when users want to set up or configure Weaviate for persistent knowledge storage.
- Reads credentials
- Installs packages
In this repository30 other files it gives its agents.
- AGENTS.mdAGENTS.md
- src/AGENTS.mdAGENTS.md
- tests/AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- av-eventsSkill
- creative-concept-designSkill
- educational-explainerSkill
- ffmpeg-productionSkill
- footage-editSkill
- gemini-visualizeSkill
- gr-advisorSkill
- hardware-evidence-captureSkill
- image-generationSkill
- mlflow-tracesSkill
- movie-commentarySkill
- plugin-maintenanceSkill
- qwen-image-integrationSkill
- qwen-video-integrationSkill
- research-brief-builderSkill
- research-visualization-blenderSkill
- research-visualization-freecadSkill
- reverse-search-video-frameSkill
- spatial-video-analysisSkill
- tts-productionSkill
- video-explainerSkill
- video-generationSkill
- video-productionSkill
- video-researchSkill
- video-to-skillSkill
- video-translationSkill
The file
Show its rules and text
We split this skill into the rules it gives an agent
15 rules. About 0 are common, 6 are distinctive, and 9 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈6
Distinctive · estimate
This author's own choices. Worth a look.
9
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 12
Follow these steps IN ORDER.
- Distinctive: line 16
Ask the user which Weaviate deployment they want to use:
- Very specific: line 58
Before retaining knowledge, add the persistent volume from the official Docker guide.
- Distinctive: line 61
Ask for the full URL (including port)
- Distinctive: line 62
Ask whether authentication is required.
- Very specific: line 90
Use a full URL with scheme (https://...
- Very specific: line 91
Verify substitutions resolve in the server process.
- Distinctive: line 101
After the user has configured the environment, tell them to restart Claude Code (or the MCP server) and test with:
- Very specific: line 128
Use knowledge_search(query="...") to find past results semantically (supports hybrid, semantic, keyword modes)
- Very specific: line 129
Use knowledge_related(object_id="...", collection="...") to find similar items
- Very specific: line 130
Use knowledge_fetch(object_id="...", collection="...") to retrieve a specific object by UUID
- Very specific: line 131
Use knowledge_stats() to see how much knowledge has accumulated
- Very specific: line 132
Use knowledge_ingest(collection="...", properties={...}) to manually insert data
- Distinctive: line 137
Ask the user if they want AI-powered Q&A over their knowledge store:
- Distinctive: line 164
If successful, they now also have:
≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Weaviate Knowledge Store Setup
You are guiding a user through setting up Weaviate as the persistent knowledge store for the video-research MCP server. Analysis and research tools attempt write-through storage when configured; infrastructure/query tools do not create analysis records and storage failures are non-fatal. Use knowledge_search, knowledge_related, knowledge_stats, knowledge_fetch, knowledge_ingest, and knowledge_schema; optional knowledge_ask provides AI Q&A. knowledge_query remains available but is deprecated in favor of knowledge_search.
Setup Flow
Follow these steps IN ORDER. Use AskUserQuestion for each decision point.
Step 1: Deployment Type
Ask the user which Weaviate deployment they want to use:
AskUserQuestion:
questions:
- question: "Which Weaviate deployment will you use?"
header: "Deployment"
multiSelect: false
options:
- label: "Weaviate Cloud (Recommended)"
description: "Managed service at console.weaviate.cloud — check current plans and embedding costs"
- label: "Local Docker"
description: "Run Weaviate locally via Docker; the selected embedding provider may still use a network service"
- label: "Custom/Self-hosted"
description: "Your own Weaviate deployment at a custom URL"Step 2: Collect Credentials (based on choice)
If Weaviate Cloud:
- Direct the user to https://console.weaviate.cloud to select an authorized plan and obtain the cluster URL/API key
- Collect the URL; have the user store the key locally and confirm its presence without pasting it into chat
If Local Docker:
- Select the server version using the official Docker guide. This example uses its 2026-10-06 documented image and OpenAI vectorizer; it is not a tested deployment receipt:
services:
weaviate:
image: cr.weaviate.io/semitechnologies/weaviate:1.39.8
ports:
- "127.0.0.1:8080:8080"
- "127.0.0.1:50051:50051"
environment:
QUERY_DEFAULTS_LIMIT: 25
AUTHENTICATION_ANONYMOUS_ACCESS_ENABLED: "true"
PERSISTENCE_DATA_PATH: "/var/lib/weaviate"
DEFAULT_VECTORIZER_MODULE: text2vec-openai
ENABLE_MODULES: text2vec-openai- Weaviate Embeddings are Cloud-only. For this Docker example, configure the already supported OpenAI vectorizer and authorize its embedding costs separately. No local model or sidecar is selected.
- The URL will be
http://localhost:8080 - Anonymous loopback access needs no Weaviate API key; the OpenAI vectorizer still needs its provider key.
- Before retaining knowledge, add the persistent volume from the official Docker guide.
PERSISTENCE_DATA_PATHalone does not preserve data when the container is replaced.
If Custom:
- Ask for the full URL (including port)
- Ask whether authentication is required; keep any API key in local configuration
Step 3: Configure Environment
Once you have the URL (and optionally API key), tell the user to configure the shared server config file (recommended) or shell env:
Option A -- Shared config file (recommended for plugin users):
Edit ~/.config/video-research-mcp/.env:
Docker deployment:
GEMINI_API_KEY=<their-gemini-key>
WEAVIATE_URL=http://localhost:8080
WEAVIATE_VECTORIZER=openai
OPENAI_API_KEY=<locally-stored-embedding-key>Cloud deployment:
GEMINI_API_KEY=<their-gemini-key>
WEAVIATE_URL=<cluster-url>
WEAVIATE_API_KEY=<locally-stored-key>
WEAVIATE_VECTORIZER=weaviateThe server auto-detects WEAVIATE_VECTORIZER based on OPENAI_API_KEY: if present → openai, otherwise → weaviate (built-in embeddings). Setting it explicitly avoids surprises.
Notes:
- Use a full URL with scheme (
https://...for cloud,http://localhost:8080for local). - Verify substitutions resolve in the server process; supported client placeholders may remain in
.mcp.json.
Option B -- Shell environment:
export WEAVIATE_URL="<their-url>"
export WEAVIATE_API_KEY="<their-key-if-any>" # only for Cloud/authenticated deploymentsStep 4: Verify Connection
After the user has configured the environment, tell them to restart Claude Code (or the MCP server) and test with:
knowledge_search(query="test")This attempts connection, collection setup, and search only when WEAVIATE_URL is configured. An empty result also occurs when storage is disabled; confirm configuration and test a known record before claiming retrieval works.
Then confirm collections exist:
knowledge_stats()Inspect the returned collection list and errors. Disabled storage returns an empty list; per-collection failures can appear as zero counts. Check a known record or server diagnostics before interpreting zeros as an empty healthy store. Troubleshoot reported errors:
| Error | Fix |
WEAVIATE_CONNECTION | Check URL is reachable, Docker is running, firewall allows the port |
WEAVIATE_SCHEMA | Check the selected server/client/vectorizer compatibility; preserve existing collections and diagnose schema drift before any authorized migration |
Weaviate not configured | WEAVIATE_URL env var is not set or server wasn't restarted |
Step 5: Confirm Working
Once knowledge_stats returns successfully, tell the user:
- The knowledge connection works; verify a known stored record separately before claiming analysis persistence
- Use
knowledge_search(query="...")to find past results semantically (supports hybrid, semantic, keyword modes) - Use
knowledge_related(object_id="...", collection="...")to find similar items - Use
knowledge_fetch(object_id="...", collection="...")to retrieve a specific object by UUID - Use
knowledge_stats()to see how much knowledge has accumulated - Use
knowledge_ingest(collection="...", properties={...})to manually insert data - The file cache continues to work alongside Weaviate -- dual persistence
Step 6: Optional -- Enable QueryAgent Tools
Ask the user if they want AI-powered Q&A over their knowledge store:
AskUserQuestion:
questions:
- question: "Do you want to enable AI-powered knowledge Q&A?"
header: "QueryAgent (Optional)"
multiSelect: false
options:
- label: "Yes -- install weaviate-agents"
description: "Enables knowledge_ask; requires weaviate-agents and a compatible authorized QueryAgent service. knowledge_query is deprecated."
- label: "No -- skip for now"
description: "You can install it later with: uv pip install 'video-research-mcp[agents]'"If yes, tell them to install the agents extra:
uv pip install 'video-research-mcp[agents]'Then restart the MCP server and test:
knowledge_ask(query="What have I researched so far?")If successful, they now also have:
knowledge_ask(query="...")-- AI-generated answers grounded in stored knowledge, with source citationsknowledge_query(query="...")-- deprecated natural-language retrieval; preferknowledge_search
These tools use Weaviate's AsyncQueryAgent, which automatically translates natural-language queries into optimized Weaviate operations.
Collections Created Automatically
| Collection | Populated by | Knowledge tools that query it |
ResearchFindings | research_deep, research_assess_evidence, research_document | Supported knowledge tools |
VideoAnalyses | video_analyze, video_batch_analyze | Supported knowledge tools |
ContentAnalyses | content_analyze, content_batch_analyze | Supported knowledge tools |
VideoMetadata | video_metadata | Supported knowledge tools |
SessionTranscripts | video_continue_session | Supported knowledge tools |
WebSearchResults | web_search | Supported knowledge tools |
ResearchPlans | research_plan | Supported knowledge tools |
DeepResearchReports | research_web_status, research_web_followup | Supported knowledge tools |
CommunityReactions | Explicit ingestion of checked comment analysis | Supported knowledge tools |
ConceptKnowledge | concept extraction/enrichment pipelines | Supported knowledge tools |
RelationshipEdges | relationship graph extraction | Supported knowledge tools |
CallNotes | Explicit ingestion of call/meeting notes | Supported knowledge tools |
AcademicPapers | Semantic Scholar discovery tools | Supported knowledge tools |
Supported Deployment URLs
| Type | Example URL | API Key |
| Weaviate Cloud | https://my-cluster-abc123.weaviate.network | Required |
| Local Docker | http://localhost:8080 | Not needed |
| Custom | https://weaviate.mycompany.com:8080 | Depends |
Graceful Degradation
Without WEAVIATE_URL, analysis remains available and write-through storage is skipped. Basic search/stats return empty results; optional agent tools can return dependency/configuration errors. Report persistence separately from analysis success.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

