Docs/mcp user guide notebook#626
Draft
nkanu17 wants to merge 2 commits into
Draft
Conversation
Add docs/user_guide/15_mcp.ipynb, a hands-on guide that creates and loads a Redis index, writes and validates an MCP config, starts the RedisVL MCP server over Streamable HTTP, exercises the search-records and upsert-records tools from an MCP client, and wires the same server to a Google ADK agent. Register the notebook in the how-to guides index (card, quick reference, and toctree).
🛡️ Jit Security Scan Results
✅ No security findings were detected in this PR
Security scan by Jit
|
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new user guide notebook documenting how to serve an existing RedisVL index over MCP (including client usage and a Google ADK agent example), and wires it into the docs navigation. Also updates the lockfile to reflect the project version bump.
Changes:
- Add
docs/user_guide/15_mcp.ipynbwalkthrough for serving an index over MCP and usingsearch-records/upsert-records(plus ADK integration). - Update
docs/user_guide/how_to_guides/index.mdto link the new MCP notebook in cards, quick-reference table, and toctree. - Update
uv.lockto reflectredisvlversion0.20.0.
Reviewed changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
uv.lock |
Updates the editable redisvl package entry to version 0.20.0. |
docs/user_guide/how_to_guides/index.md |
Adds navigation entries pointing to the new MCP notebook. |
docs/user_guide/15_mcp.ipynb |
Introduces a hands-on MCP notebook (index creation, config, server/client usage, ADK agent example, cleanup). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+47
to
+49
| "source": [ | ||
| "%pip install -q \"redisvl[mcp,sentence-transformers]>=0.20.0\" nest_asyncio pandas" | ||
| ] |
Comment on lines
+66
to
+71
| "import os\n", | ||
| "import warnings\n", | ||
| "\n", | ||
| "import nest_asyncio\n", | ||
| "import pandas as pd\n", | ||
| "\n", |
Comment on lines
+258
to
+264
| "# NBVAL_SKIP\n", | ||
| "import socket\n", | ||
| "import subprocess\n", | ||
| "import time\n", | ||
| "\n", | ||
| "from fastmcp import Client\n", | ||
| "\n", |
| " return tool_names\n", | ||
| " except Exception as exc: # not ready yet, keep polling\n", | ||
| " last_error = exc\n", | ||
| " time.sleep(1.0)\n", |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.