garnet-mcp

io.github.tarazou9由 GitHub 账号 tarazou9 发布v0.1.2更新于 Oct 27, 2026

RAG memory for LLM agents over Garnet Vector Sets: store text as embeddings, recall by meaning.

已验证STDIO仅桌面数据库知识与记忆

概览

AI 生成的概览

为 LLM 智能体提供基于 Garnet Vector Sets 的持久化 RAG 记忆:把文本存为向量,之后按语义召回。

可以做什么
  • 把事实或文本片段写入长期记忆并返回记忆 id
  • 按语义相似度召回记忆,返回最接近的匹配及分数
  • 按 id 删除已存储的记忆
  • 列出已有的向量集记忆索引,并查看某个索引的元数据(度量方式、维度、大小)
适用场景
希望助手在多次对话和会话之间记住持久的事实、偏好或决定,并且使用自己的 Garnet 或兼容 Redis 的向量存储,而不是托管记忆服务时。
运行要求
通过 dnx 命令以 stdio 在本地运行,需要 .NET 10 SDK。需要一个启用了 Vector Sets 的 Garnet 服务器(或兼容 Redis 的端点),启动时需开启向量集预览开关。连接信息来自 GarnetHost 与 GarnetPort。要获得真实向量需将 EmbeddingsProvider 设为 AzureOpenAI,并配置 EmbeddingsEndpoint、EmbeddingsDeploymentName 和 EmbeddingsDimensions,可用无密钥的 DefaultAzureCredential 或可选的 API 密钥;否则会使用无语义的 Fake 提供程序。
安装前请注意
Fake 向量提供程序是确定性的、没有语义意义,只有配合 Azure OpenAI 等真实提供程序时召回才有用。该服务器会向你的 Garnet 存储写入、删除并持久保存数据,记忆会跨会话保留。记忆归属由 MemoryUser 在整个进程生命周期内固定,托管的多用户部署需要真正的调用方身份。Garnet Vector Sets 与所固定的 MCP SDK 均为预览功能。可提供可选的 EmbeddingsApiKey,但更推荐无密钥认证。

安装

在 SourceWeft 中

  1. 打开 控制台中的 garnet-mcp,将其添加到工作区。
  2. 为需要使用其工具的对话启用该服务。

Desktop only,通过 STDIO。 STDIO 服务会启动本地进程,因此需要 SourceWeft 桌面宿主。

其他 MCP 客户端

参照 仓库 中的启动说明。

README

Garnet Vector Memory MCP Server

An MCP (Model Context Protocol) server that gives LLM agents a retrieval-augmented (RAG) memory backed by Garnet Vector Sets. Agents store text as embeddings and later retrieve the most semantically relevant snippets by meaning to ground their responses — persisting across sessions, not just within a single conversation. This is application-layer semantic recall (RAG): it augments the model's prompt with retrieved context, and is distinct from inference-layer KV-cache reuse (e.g. LMCache). It runs against a local or self-hosted OSS Garnet (or any Redis-compatible endpoint that supports Vector Sets), with bring-your-own embeddings.

Tools

The server exposes five tools over the MCP stdio transport (HTTP is also supported):

ToolDescription
store_memoryPersist a fact or piece of text to long-term memory. Returns a memory id.
recall_memorySemantic search over stored memories; returns the closest matches with scores.
forget_memoryDelete a stored memory by its id.
list_indexesList the vector-set memory indexes that currently exist.
index_infoShow metadata (metric, dimensions, size) for a memory index key.

Prerequisites

  • .NET 10 SDK — required so clients can launch the server with the dnx command (ships with the .NET 10 SDK). The package itself targets net9.0.
  • A Garnet server started with Vector Sets enabled. Vector Sets are currently a Garnet preview feature and must be turned on explicitly with --enable-vector-set-preview. Any Redis-compatible endpoint exposing the V* vector commands also works.
  • Embeddings (optional but recommended). Set Embeddings__Provider=AzureOpenAI and point it at an Azure OpenAI embedding deployment (keyless auth via DefaultAzureCredential / az login). Without it, the server falls back to a deterministic Fake provider that requires no external calls — useful for local demos and tests, but not for meaningful semantic recall.

Install (from NuGet)

The server is published as a .NET tool package that MCP clients run via dnx. Add it to your client's MCP config, e.g. .vscode/mcp.json for VS Code / GitHub Copilot:

json
{
  "servers": {
    "garnet-mcp": {
      "type": "stdio",
      "command": "dnx",
      "args": ["[email protected]", "--yes"],
      "env": {
        "Garnet__Host": "127.0.0.1",
        "Garnet__Port": "6379",
        "Embeddings__Provider": "AzureOpenAI",
        "Embeddings__Endpoint": "https://YOUR-RESOURCE.openai.azure.com/",
        "Embeddings__DeploymentName": "text-embedding-3-small",
        "Embeddings__Dimensions": "1536"
      }
    }
  }
}

To run the fully offline demo, drop the Embeddings__* entries (or set Embeddings__Provider=Fake).

Recommended agent instructions

The server already sends usage guidance to any MCP client at connect time (via the server's ServerInstructions), so most agents will use the tools appropriately on their own. If you want to make an agent use the memory proactively, add something like the following to that agent's custom-instructions (e.g. .github/copilot-instructions.md in your project, a Claude/Cursor rules file, etc.):

Before answering anything about the user — their preferences, facts, decisions, or past statements — FIRST call recall_memory, even if the answer seems to be in the current chat (memories persist across sessions). Whenever the user states a durable fact about themselves or asks you to remember something, call store_memory to persist it, then briefly confirm what you saved.

Configuration

All settings are read from configuration / environment variables. In environment-variable form, use __ (double underscore) as the section separator.

SettingEnv varDefaultNotes
Garnet hostGarnet__Host127.0.0.1Blank is treated as the default.
Garnet portGarnet__Port6379
Key prefixGarnet__KeyPrefixmemPrefix for memory index keys.
Log Redis commandsGarnet__LogRedisCommandsfalseSet true to log the equivalent redis-cli command at Debug (troubleshooting).
Log levelLogging__LogLevel__DefaultInformationDefault is a quiet startup line + warnings/errors. Set Debug for per-call tool tracing. Logs go to stderr on the stdio transport.
Embedding providerEmbeddings__ProviderFakeAzureOpenAI or Fake.
Azure OpenAI endpointEmbeddings__Endpoint—Required when provider is AzureOpenAI.
Deployment nameEmbeddings__DeploymentNametext-embedding-3-small
DimensionsEmbeddings__Dimensions1536 (AOAI) / 8 (Fake)Must match the embedding model.
API keyEmbeddings__ApiKey—Optional; prefer keyless DefaultAzureCredential.
Memory ownerMemory__UserdefaultPins the memory owner so store and recall always agree.
TransportTransportStdioStdio (local) or Http (hosted).

Embedding providers

Two providers ship out of the box:

  • AzureOpenAI — real embeddings; the only production-quality option. Keyless via DefaultAzureCredential (or an API key).
  • Fake — deterministic, offline, hash-seeded vectors. Useful for local runs and tests, but not semantically meaningful — don't use it for real recall.

Embedding generation sits behind the IEmbeddingProvider abstraction (EmbedAsync / EmbedBatchAsync, plus ModelName and Dimensions). The rest of the system — GarnetMemoryStore, the vector client, and the tools — depends solely on this interface, so additional backends (for example OpenAI, a local model served via Ollama, or Hugging Face) can be introduced without touching that code. To add one, implement IEmbeddingProvider and register it in Program.cs (ConfigureDomain) under the corresponding Embeddings__Provider value.

Memory ownership (single-tenant by design)

The memory owner is pinned by configuration (Memory__User, default default) for the lifetime of the server process — the model cannot choose it per call. Both store_memory and recall_memory are scoped to that owner (recall filters on the stored user attribute), so store and recall always agree across chats and sessions.

This suits the shipped model: a personal, single-owner server launched over stdio by your own client — the process is the user. Letting the model supply the user per call is deliberately avoided because it would let store and recall drift apart (models are inconsistent) and would let one caller read or overwrite another owner's memories.

For a hosted, multi-tenant deployment (the Http transport serving many people), the correct source of the owner is the authenticated caller's identity (from the auth token/headers) — never a value chosen by the model. That is a deliberate future enhancement, not something to wire through the tool arguments.

Build and run from source

bash
# Build + test the solution (integration tests self-skip when Garnet/AOAI are unreachable).
dotnet test src/GarnetMcp.slnx

# Run the server directly over stdio.
dotnet run --project src/GarnetMcp.Server

# Optional: interactive console to try store/recall/forget by hand (dev only; not part of the package).
dotnet run --project src/GarnetMcp.Demo

Start a local Garnet with Vector Sets enabled before exercising the memory tools:

bash
garnet --enable-vector-set-preview true

Caveats

  • Preview MCP SDK. This project pins ModelContextProtocol 2.0.0-preview.2. The SDK's API surface may change between preview releases.
  • Garnet Vector Sets are preview. Start Garnet with --enable-vector-set-preview, or memory tools return a clear "Vector Sets are not enabled" error.
  • list_indexes on a multi-node cluster. Index enumeration uses SCAN on the connected node, so against a self-hosted multi-node Garnet cluster it returns only that node's keys (partial results). Single-node / self-hosted setups are unaffected, and store_memory / recall_memory / forget_memory are unaffected either way (they operate on specific keys).

License

MIT © Tara Zou

来源:README.md,提交 aa4058d

工具

0
SourceWeft 尚未在沙箱中启动过该软件包,因此其工具未知。

版本历史

1
  1. v0.1.2最新Sep 16, 2026

评分

已满足适用检查项的 50%

该评分衡量此收录条目的完整程度,依据注册中心条目、端点与公开来源计算得出。它不是对服务器本身的评价,也不表示服务器安全或当前可用:可连通性是带日期的检查结果,评分也不包含安装量或用户评价。

  • 近 30 天内可连通25 分

    请保持端点能够响应 MCP 握手;SourceWeft 每 30 天探测一次。

  • 已声明认证方式10 分

    请在注册中心条目中声明凭据请求头,或保持端点能够响应探测,以便判定其认证方式。

  • 已列出工具15 分

    请让服务器在无凭据时响应 tools/list,或发布可在沙箱中无凭据启动的软件包。

  • 描述必需15 分
  • 图标10 分
  • 文档15 分
  • 许可证10 分