Context retriever quickstart - #4116
Merged
Merged
Conversation
CLI walkthrough covering install, admin-key creation, entity modeling, surface/agent-key creation, and calling a generated tool with ctxctl. Notes the Redis Cloud vs. self-managed sign-in split and links out to the install guide for the self-managed path. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Now that concepts.md is back on main post-rebase, link it from the quickstart's Next steps, and point concepts.md's Next steps at the quickstart instead of the bare PyPI link. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Relocate the self-managed install guide from develop/ai/context-engine/context-retriever/install/ to operate/iris/context-retriever/self-managed/, matching the directory convention LangCache and Agent Memory already use. Update frontmatter to match operate/iris siblings, add a redirect alias for the old path, update every internal link that pointed at it, and add the missing self-managed cross-link on the operate/iris/context-retriever index page for parity with its siblings. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Contributor
Contributor
🧠 Redis MemoryFound 6 related items from repository history:
Memory updated at a532a72 |
n-valchev
approved these changes
Sep 25, 2026
andy-stark-redis
approved these changes
Sep 25, 2026
andy-stark-redis
left a comment
andy-stark-redis
left a comment
Contributor
There was a problem hiding this comment.
Minor suggestion for the quickstart content itself, otherwise LGTM.
Co-authored-by: andy-stark-redis <164213578+andy-stark-redis@users.noreply.github.com>
kaitlynmichael
approved these changes
Sep 25, 2026
kaitlynmichael
left a comment
kaitlynmichael
left a comment
Contributor
There was a problem hiding this comment.
Few suggestions, looks good!
- Add a "Load sample data" step with concrete redis-cli commands so the tool-call example returns predictable, documented results instead of "whatever data you happen to have." - Number the multi-action sections (sign in/create admin key, create surface, create agent key) per house style. - Replace the long run-on intro sentence with a scannable, linked list of the quickstart's steps. - Rename the Context Retriever self-managed page's title/linkTitle to include "Install" so it isn't mistaken for an overview page.
EliShteinman
added a commit
to EliShteinman/docs
that referenced
this pull request
Sep 26, 2026
Adds a Context Retriever CLI quickstart and moves the self-managed install guide under operate/iris. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
EliShteinman
added a commit
to EliShteinman/docs
that referenced
this pull request
Sep 29, 2026
Adds a Context Retriever CLI quickstart and moves the self-managed install guide under operate/iris. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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
4 participants
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.
add missing quickstart doc for context retriever and move the context retriever self-managed install page to the operate section
Note
Low Risk
Documentation-only changes: new quickstart page, updated cross-links, and a URL alias for the relocated install guide.
Overview
Adds a Context Retriever quickstart that walks through
ctxctlend-to-end: install the Python client, auth and admin keys, define amodels.pyentity, load sample Redis data, create a surface and agent key, list generated MCP tools, callsearch_customer_by_text, and clean up.Self-managed install is repositioned in docs under Operate → Iris (
/operate/iris/context-retriever/self-managed), with title/link updates,operate/iriscategories, and a redirect alias from the old develop path/develop/ai/context-engine/context-retriever/install/.Develop and operate pages now point readers to the quickstart and the new self-managed URL instead of the removed develop install link.
Reviewed by Cursor Bugbot for commit a532a72. Bugbot is set up for automated code reviews on this repo. Configure here.