@memofs/mcp-server

@memofs/mcp-server

         

Model Context Protocol server for MemoFS agent integrations.

What is this?

The @memofs/mcp-server package allows AI coding agents (like Claude Desktop, Cursor, Zed, and OpenCode) to securely read, search, and update project memory using the Model Context Protocol (MCP). It wraps the core runtime and exposes 10 model-facing tools (4 memory verbs + 6 AgentFS session tools) and 9 resources for memory, graph, and session access.

Installation

Most MCP clients invoke the server on demand via npx — no install required:

npx -y @memofs/mcp-server --help

If you want to install the server as a dev dependency instead:

npm install -D @memofs/mcp-server

Requires Node.js >= 22.

Or use directly via npx in your client's configuration:

npx -y @memofs/mcp-server --help

Quick Start

You can configure your MCP client (e.g., Claude Desktop, Cursor, or any MCP client) to start the server via stdio.

MCP clients config

{
  "mcpServers": {
    "memofs": {
      "command": "npx",
      "args": [
        "-y",
        "@memofs/mcp-server",
        "--runtime",
        "local",
        "--root",
        "/absolute/path/to/project"
      ]
    }
  }
}

Configuration and Usage

The server supports two runtime modes (local, hybrid), cloud sync via --cloud-url and --api-key, and a strict --read-only flag to block mutating tools when used with untrusted clients.

For comprehensive setup instructions across all major AI tools, the full list of exposed tools and resources, and runtime mode options, please refer to the Full Documentation.

Contributing

See our central Contributing Guide and development scripts for details on formatting, linting, and testing within the monorepo.

License

MIT