Skip to Content

Available Tools

The localwiki-mcp server exposes the following tools to AI clients:

ToolDescription
search_pagesFull-text search across all wiki pages. Returns titles and content snippets ranked by relevance.
list_workspacesList all workspaces with metadata (name, icon, color, role, timestamps).
list_pagesList pages in a workspace (or all pages). Returns title, favorite status, parent hierarchy, and timestamps.
read_pageRead the full plaintext content of a wiki page by its ID.
get_page_historyGet version history snapshots for a page, newest first.
list_projectsList projects in a workspace. Projects group environment secrets by application.
list_secretsList secret metadata (name, environment, timestamps) for a workspace or project. Values are never exposed.
vault_statusCheck whether the localWiki vault is locked or unlocked (connects to the running app via IPC).

Example Prompts

Once your editor is connected to the localwiki-mcp server, you can ask your AI assistant questions that reference your workspace data.

Reading Documentation

"Read the API authentication page from our wiki and help me implement the auth middleware."

The assistant calls read_page to fetch your documentation, then uses it as context for code generation.

Understanding Project Config

"What environment variables does the billing service need? List them with descriptions."

The assistant calls list_secrets with the workspace ID and returns the key names and environment tags from your secret store.

Searching for Context

"Search our docs for anything related to the webhook retry policy."

The assistant calls search_pages with the query “webhook retry” and returns matching pages with relevance-ranked snippets.

Checking Vault State

"Is the vault currently unlocked?"

The assistant calls vault_status to check if the app is running and the vault is accessible.

The MCP server only exposes secret names, environments, and timestamps — never the actual secret values. All text output is redacted through a security gate before being returned. Your AI assistant cannot read your passwords, tokens, or connection strings.

Tool Schemas

Each tool accepts JSON parameters. Examples:

search_pages

{ "name": "search_pages", "arguments": { "query": "webhook retry", "limit": 10 } }

list_pages

{ "name": "list_pages", "arguments": { "workspace_id": "abc123" } }

read_page

{ "name": "read_page", "arguments": { "page_id": "page-uuid-here" } }

list_secrets

{ "name": "list_secrets", "arguments": { "workspace_id": "abc123", "project_id": "optional-project-id" } }

list_projects

{ "name": "list_projects", "arguments": { "workspace_id": "abc123" } }

Refer to your editor’s MCP documentation for how tool calls are surfaced in the UI.

Last updated on