Skip to content

docs: MCP server guide, threat model and architecture - #115

Merged
FabioHAraujo merged 1 commit into
mainfrom
docs/mcp
Oct 29, 2026
Merged

FabioHAraujo merged 1 commit into
mainfrom
docs/mcp

Conversation

@FabioHAraujo

Copy link
Copy Markdown
Contributor

Builds on #113 and #114: merge those first. Until then this diff also shows their commits. This PR itself changes only Markdown.

Documentation for the MCP server

  • docs/MCP.md (new) is the user guide. It covers:
    • turning the server on and sharing vaults;
    • configuration for Claude Desktop, Claude Code and Cursor, and where lownotes-mcp lives on each system (and why the AppImage does not work);
    • the five tools and the note resource;
    • what leaves LowNotes, prompt injection from synced notes, who can connect, regenerating the token, and what the log records;
    • troubleshooting by the bridge's error messages.
  • docs/THREAT-MODEL.md:
    • the MCP token is listed as an asset;
    • a new section covers local MCP clients and their models: off by default, read-only, only shared vaults, the per-user pipe DACL and Unix socket permissions, the token in the credential store, the check that the pipe's server runs as the same user, request limits, data reaching the client's provider, prompt injection, and logging;
    • two new known limits: a client with other tools can be steered by injected text, and any process of the same user can read the token from the credential store.
  • docs/ARCHITECTURE.md:
    • rows for vault_service.rs and the MCP modules;
    • the server's threads (Tauri async runtime, tool calls on the blocking pool, restarts that wait for the endpoint) and the bridge process, which never opens the vault;
    • the token and the socket in the data table.
  • README.md: a "Bring your own AI app" line and an "AI apps over MCP" section that links to the guide.
  • CHANGELOG.md: one entry under [Unreleased] → Added covering MCP server inside the app with read-only tools over a local pipe or socket #101–Document the MCP server in the threat model, architecture and a user guide #104. No version section.

Relative links were checked. The full AGENTS.md verification ran on #114's tree, which this branch only extends with Markdown.

Closes #104

@FabioHAraujo FabioHAraujo added documentation Improvements or additions to documentation priority: P2 Important: performance, architecture or release quality size: S Small: up to a day of focused work area: docs Repository documentation security Security or privacy impact labels Oct 29, 2026
docs/MCP.md explains how to turn the server on, connect Claude Desktop,
Claude Code and Cursor, the tools available, what leaves LowNotes and how to
troubleshoot. The threat model gains a section on local MCP clients and two
known limits; the architecture lists the MCP modules, their threads and the
endpoint. README and CHANGELOG mention the feature.

Closes #104
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area: docs Repository documentation documentation Improvements or additions to documentation priority: P2 Important: performance, architecture or release quality security Security or privacy impact size: S Small: up to a day of focused work

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document the MCP server in the threat model, architecture and a user guide

1 participant