Skip to main content

MCP server to work with LogSeq via the local HTTP server

Project description

MCP LogSeq

MCP server for LogSeq

Connect Claude to your LogSeq knowledge base. Read, create, and manage pages — with optional semantic vector search and DB-mode graph support.

✨ What You Can Do

Transform your LogSeq knowledge base into an AI-powered workspace! This MCP server enables Claude to seamlessly interact with your LogSeq graphs.

🎯 Real-World Examples

📊 Intelligent Knowledge Management

"Analyze all my project notes from the past month and create a status summary"
"Find pages mentioning 'machine learning' and create a study roadmap"
"Search for incomplete tasks across all my pages"

📝 Automated Content Creation

"Create a new page called 'Today's Standup' with my meeting notes"
"Add today's progress update to my existing project timeline page"  
"Create a weekly review page from my recent notes"

🔍 Smart Research & Analysis

"Compare my notes on React vs Vue and highlight key differences"
"Find all references to 'customer feedback' and summarize themes"
"Create a knowledge map connecting related topics across pages"

🧠 Semantic Search (optional, requires vector setup)

"Find everything I wrote about burnout, even if I didn't use that word"
"What notes relate to my thoughts on deep work?"
"Search across my Dutch and English notes for ideas about productivity"

🤝 Meeting & Documentation Workflow

"Read my meeting notes and create individual task pages for each action item"
"Get my journal entries from this week and create a summary page"
"Search for 'Q4 planning' and organize all related content into a new overview page"

💡 Key Benefits

  • Zero Context Switching: Claude works directly with your LogSeq data
  • Preserve Your Workflow: No need to export or copy content manually
  • Intelligent Organization: AI-powered page creation, linking, and search
  • Enhanced Productivity: Automate repetitive knowledge work
  • Semantic Vector Search (optional): Find notes by meaning using local Ollama embeddings — no data leaves your machine
  • DB-mode Support (opt-in): Read and write class properties on Logseq DB-mode graphs

🚀 Quick Start

Step 1: Enable LogSeq API

  1. SettingsFeatures → Check "Enable HTTP APIs server"
  2. Click the API button (🔌) in LogSeq → "Start server"
  3. Generate API token: API panel → "Authorization tokens" → Create new

Step 2: Add to Claude (No Installation Required!)

Claude Code

claude mcp add mcp-logseq \
  --env LOGSEQ_API_TOKEN=your_token_here \
  --env LOGSEQ_API_URL=http://localhost:12315 \
  -- uv run --with mcp-logseq mcp-logseq

Claude Desktop

Add to your config file (Settings → Developer → Edit Config):

{
  "mcpServers": {
    "mcp-logseq": {
      "command": "uv",
      "args": ["run", "--with", "mcp-logseq", "mcp-logseq"],
      "env": {
        "LOGSEQ_API_TOKEN": "your_token_here",
        "LOGSEQ_API_URL": "http://localhost:12315"
      }
    }
  }
}

Step 3: Start Using!

"Please help me organize my LogSeq notes. Show me what pages I have."

🔬 Vector Search (Optional)

Semantic search over your Logseq graph using local AI embeddings — find notes by meaning, not just keywords. Searches across all your pages using vector similarity and full-text search combined, with cross-language support.

Powered by Ollama (local embeddings) and LanceDB (embedded vector DB). No data leaves your machine.

Full setup guide: VECTOR_SEARCH.md


🛠️ Available Tools

The server provides 16 tools with intelligent markdown parsing, plus 3 optional vector search tools:

Tool Purpose Example Use
list_pages Browse your graph "Show me all my pages"
get_page_content Read page content "Get my project notes"
create_page Add new pages with structured blocks "Create a meeting notes page with agenda items"
update_page Modify pages (append/replace modes) "Update my task list"
delete_page Remove pages "Delete the old draft page"
delete_block Remove a block by UUID "Delete this specific block"
update_block Edit block content by UUID "Update this specific block text"
search Find content across graph "Search for 'productivity tips'"
query Execute Logseq DSL queries "Find all TODO tasks tagged #project"
find_pages_by_property Search pages by property "Find all pages with status = active"
get_pages_from_namespace List pages in a namespace "Show all pages under Customer/"
get_pages_tree_from_namespace Hierarchical namespace view "Show Projects/ as a tree"
rename_page Rename with reference updates "Rename 'Old Name' to 'New Name'"
get_page_backlinks Find pages linking to a page "What links to this page?"
insert_nested_block Insert child/sibling blocks "Add a child block under this task"
set_block_properties Set DB-mode class properties on a block "Set the status of this block to active" (DB-mode only)
vector_search ⚗️ Semantic search by meaning "Find notes about shadow work or Jung"
sync_vector_db ⚗️ Sync vector DB with graph files "Update the search index"
vector_db_status ⚗️ Show vector DB health and staleness "Is my search index up to date?"

⚗️ Requires vector search setup — see VECTOR_SEARCH.md

🎨 Smart Markdown Parsing (v1.1.0+)

The create_page and update_page tools now automatically convert markdown into Logseq's native block structure:

Markdown Input:

---
tags: [project, active]
priority: high
---

# Project Overview
Introduction paragraph here.

## Tasks
- Task 1
  - Subtask A
  - Subtask B
- Task 2

## Code Example
```python
def hello():
    print("Hello Logseq!")

**Result:** Creates properly nested blocks with:
- ✅ Page properties from YAML frontmatter (`tags`, `priority`)
- ✅ Hierarchical sections from headings (`#`, `##`, `###`)
- ✅ Nested bullet lists with proper indentation
- ✅ Code blocks preserved as single blocks
- ✅ Checkbox support (`- [ ]` → TODO, `- [x]` → DONE)

**Update Modes:**
- **`append`** (default): Add new content after existing blocks
- **`replace`**: Clear page and replace with new content

---

## ⚙️ Prerequisites

### LogSeq Setup
- **LogSeq installed** and running
- **HTTP APIs server enabled** (Settings → Features)
- **API server started** (🔌 button → "Start server")  
- **API token generated** (API panel → Authorization tokens)

### System Requirements
- **[uv](https://docs.astral.sh/uv/)** Python package manager
- **MCP-compatible client** (Claude Code, Claude Desktop, etc.)

---

## 🔧 Configuration

### Environment Variables
- **`LOGSEQ_API_TOKEN`** (required): Your LogSeq API token
- **`LOGSEQ_API_URL`** (optional): Server URL (default: `http://localhost:12315`)
- **`LOGSEQ_DB_MODE`** (optional): Set to `true` to enable DB-mode property support. Only for Logseq DB-mode graphs (beta). Markdown/file-based graph users should leave this unset.

### Alternative Setup Methods

#### Using .env file
```bash
# .env
LOGSEQ_API_TOKEN=your_token_here
LOGSEQ_API_URL=http://localhost:12315

System environment variables

export LOGSEQ_API_TOKEN=your_token_here
export LOGSEQ_API_URL=http://localhost:12315

🔍 Verification & Testing

Test LogSeq Connection

uv run --with mcp-logseq python -c "
from mcp_logseq.logseq import LogSeq
api = LogSeq(api_key='your_token')
print(f'Connected! Found {len(api.list_pages())} pages')
"

Verify MCP Registration

claude mcp list  # Should show mcp-logseq

Debug with MCP Inspector

npx @modelcontextprotocol/inspector uv run --with mcp-logseq mcp-logseq

🐛 Troubleshooting

Common Issues

"LOGSEQ_API_TOKEN environment variable required"

  • ✅ Enable HTTP APIs in Settings → Features
  • ✅ Click 🔌 button"Start server" in LogSeq
  • ✅ Generate token in API panel → Authorization tokens
  • ✅ Verify token in your configuration

"spawn uv ENOENT" (Claude Desktop)

Claude Desktop can't find uv. Use the full path:

which uv  # Find your uv location

Update config with full path:

{
  "mcpServers": {
    "mcp-logseq": {
      "command": "/Users/username/.local/bin/uv",
      "args": ["run", "--with", "mcp-logseq", "mcp-logseq"],
      "env": { "LOGSEQ_API_TOKEN": "your_token_here" }
    }
  }
}

Common uv locations:

  • Curl install: ~/.local/bin/uv
  • Homebrew: /opt/homebrew/bin/uv
  • Pip install: Check with which uv

Connection Issues

  • ✅ Confirm LogSeq is running
  • ✅ Verify API server is started (not just enabled)
  • ✅ Check port 12315 is accessible
  • ✅ Test with verification command above

👩‍💻 Development

For local development, testing, and contributing, see DEVELOPMENT.md.


Ready to supercharge your LogSeq workflow with AI?

Star this repo if you find it helpful!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mcp_logseq-1.6.2.tar.gz (1.2 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mcp_logseq-1.6.2-py3-none-any.whl (52.6 kB view details)

Uploaded Python 3

File details

Details for the file mcp_logseq-1.6.2.tar.gz.

File metadata

  • Download URL: mcp_logseq-1.6.2.tar.gz
  • Upload date:
  • Size: 1.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.22

File hashes

Hashes for mcp_logseq-1.6.2.tar.gz
Algorithm Hash digest
SHA256 1837155626b09b1da2690623b39dc40c865f11711e6114dc8a4b776b8b8506d7
MD5 3f77649f65fe848899ee88d42124a51f
BLAKE2b-256 0a7f271c476fdeca246f3cccc591180b6772483e6118534653c2d111a317a900

See more details on using hashes here.

File details

Details for the file mcp_logseq-1.6.2-py3-none-any.whl.

File metadata

  • Download URL: mcp_logseq-1.6.2-py3-none-any.whl
  • Upload date:
  • Size: 52.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.22

File hashes

Hashes for mcp_logseq-1.6.2-py3-none-any.whl
Algorithm Hash digest
SHA256 e3728167af89f694c2085d927aa7db504fc67ff101a030e66dc1bd7f80dcddc0
MD5 8d99d88b1f8d63ab1e8524573ce68b44
BLAKE2b-256 61aa321dc7f5906577b083052e9c5dd64a1332e55fa6de270b93d4528681c128

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page