@cyanmycelium/mcp-cache
v0.1.0
Published
The cache.v1 contract above an mcp-broker: UNS-addressed values with a time to live, its MCP slot surface, broker-decided access, an in-memory store and the conformance suite every store must pass.
Maintainers
Readme
mcp-cache
Cache slots for an mcp-broker: one contract, cache.v1, for values kept by UNS id with a time to live, and pluggable stores.
MCP client ──> mcp-broker ──> slot "cache" (CacheBehavior)
│ one broker decision per UNS id, audited
└──> ICacheStore: memory, RedisEntries are addressed by UNS id, like SCADA values and their history: one broker policy governs the live value, its history and its cached copy. UNS ids and broker-decided access come from mcp-uns.
Design and decisions: docs/brief_cache_slot.md (French).
Packages
| package | what |
|---|---|
| @cyanmycelium/mcp-cache | the contract, MemoryCacheStore, CacheBehavior, CacheSlotStore, the declaration, and the conformance suite under /conformance |
| @cyanmycelium/mcp-cache-redis | RedisCacheStore: one cache shared by every process, expiry kept by the server |
Use
import { DirectTransport } from "@cyanmycelium/mcp-broker-provider";
import { McpServerBuilder } from "@cyanmycelium/mcp-core";
import { CacheBehavior, buildCacheDeclaration } from "@cyanmycelium/mcp-cache";
import { RedisCacheStore } from "@cyanmycelium/mcp-cache-redis";
import { BrokerAccessGuard } from "@cyanmycelium/mcp-uns";
const store = await RedisCacheStore.connectAsync("redis://127.0.0.1:6379", { prefix: "site1:" });
const transport = new DirectTransport("ws://localhost:3000/provider/cache", { secret });
const server = new McpServerBuilder().withName("cache").withTransport(transport).register(new CacheBehavior(store, new BrokerAccessGuard(transport.broker))).build();
await server.start();
await transport.broker.declare(buildCacheDeclaration({ version: "1", namespace: "uns://site1" }));Tools
| tool | broker capability, checked per id |
|---|---|
| cache.capabilities | none |
| cache.get | cache.read: each id answers hit, miss, or a refusal |
| cache.scan | cache.read (ids you may not read are left out) |
| cache.set, cache.delete | cache.write, outcome reported |
Develop
npm install
npm run typecheck
npm test
npm run buildThe Redis store runs the conformance suite on a fake Redis that misbehaves the way SCAN may. Against a real server, give the standard Redis settings in the environment or in a .env file at the root, which git ignores:
REDIS_URL=rediss://my-cache.example.com:6380
REDIS_PASSWORD=<password>REDIS_URL carries its scheme: rediss:// for TLS (Azure Cache for Redis on 6380, for one), redis:// otherwise. REDIS_PASSWORD and REDIS_USERNAME (for an ACL user) are optional. Each test writes under its own key prefix and deletes its keys afterwards.
tests/broker.test.ts starts a real broker with @cyanmycelium/mcp-broker/testing.
License
Apache-2.0.
