granite-mem 0.1.2 → 0.1.4

package/README.md

@@ -60,6 +60,7 @@ Granite is designed to be easy for agents to read and act on:
 - notes are plain files
 - metadata is explicit
 - commands support `--json`
+- Granite ships with an MCP server
 - vault structure is predictable
 - search, backlinks, and recommendations are available from the CLI
 
@@ -77,7 +78,7 @@ npm run build
 npm link
 ```
 
-Create a vault and start capturing:
+Create the default vault in `~/.granite` and start capturing:
 
 ```bash
 mem init
@@ -85,7 +86,13 @@ mem add "Talked to Alice about local-first sync tradeoffs"
 mem new "Local-first sync tradeoffs" --type permanent
 mem list
 mem search "sync"
-mem serve
+```
+
+Start one long-running interface when you need it:
+
+```bash
+mem serve   # local web UI
+mem mcp     # MCP server for agent clients
 ```
 
 `mem new` does more than create a file. It can immediately suggest related links, tags, and the next note to create, which is the core of Granite's value loop.
@@ -153,8 +160,9 @@ Granite keeps the source of truth boring and durable:
 
 - notes are Markdown files
 - metadata lives in YAML frontmatter
-- vault configuration lives in `granite.yml`
-- full-text search and link resolution are backed by a local SQLite index in `.granite/index.db`
+- the default vault lives in `~/.granite`
+- vault configuration lives in `~/.granite/granite.yml`
+- full-text search and link resolution are backed by a local SQLite index in `~/.granite/index.db`
 - the index can be rebuilt from the files at any time
 
 This keeps the system transparent, portable, and inspectable.
@@ -174,6 +182,37 @@ mem recommend sync-constraints --json
 
 That makes Granite a useful substrate for local workflows, scripts, and agent memory.
 
+## MCP Server
+
+Granite ships with an MCP server so LLM clients can control the vault directly through tools, resources, and prompts.
+
+Start it over stdio for local MCP clients:
+
+```bash
+mem mcp --vault /path/to/vault
+```
+
+Start it over Streamable HTTP:
+
+```bash
+mem mcp --transport http --host 127.0.0.1 --port 3321
+```
+
+The server exposes:
+
+- tools for vault overview, list/get/search, create/update, backlinks, link suggestions, recommendations, and doctor
+- resources for `granite.yml`, vault overview, note types, and individual notes via `granite://notes/{slug}`
+- prompts for refining notes and reviewing links/next steps
+
+Example stdio client configuration:
+
+```json
+{
+  "command": "mem",
+  "args": ["mcp", "--vault", "/path/to/vault"]
+}
+```
+
 ## Commands
 
 ```bash
@@ -191,6 +230,7 @@ mem recommend <slug> [--json]
 mem types
 mem doctor
 mem serve [-p <port>]
+mem mcp [--vault <path>] [--transport <stdio|http>]
 ```
 
 ## Development