Skip to main content
Glama
Sign In
deenesjakoruzh
Logseq MCP Tools

Logseq MCP Tools

by mikeysrecipes
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Local

logseq-mcp-main

Logseq MCP Tools

This project provides a set of Model Context Protocol (MCP) tools that enable AI agents to interact with your local Logseq instance.

Installation

  1. Ensure you have Python 3.11+ installed

  2. Clone this repository

  3. Install dependencies:

    pip install -e .

Related MCP server: Logseq MCP Tools

Setup

  1. Make sure your Logseq has the API enabled.

    • In Logseq, go to Settings > Advanced > Developer mode > Enable Developer mode

    • Then, go to Plugins > Turn on Logseq Developer Plugin

    • Also set an API token in the Advanced settings

    • Restart Logseq

  2. Configure the MCP server in your Cursor MCP configuration file (typically at ~/.cursor/mcp.json):

    {
  "mcpServers": {
    "logseq": {
      "command": "/opt/homebrew/bin/uvx",
      "args": ["logseq-mcp"],
      "env": {
        "LOGSEQ_API_URL": "http://localhost:12315",
        "LOGSEQ_TOKEN": "your-token-here"
      }
    }
  }
}

OR

  1. Configure Claude Code to use the MCP server with:

claude mcp add

  • Select scope

  • Select Stdio

  • LOGSEQ_API_URL=http://localhost:12315 LOGSEQ_TOKEN=your-token-here /opt/homebrew/bin/uvx logseq-mcp

Using with Cursor and Claude

Adding to Cursor's MCP Tools

  1. Configure the MCP server as shown above in the Setup section

  2. Open Cursor and go to the MCP panel (sidebar)

  3. The Logseq tool should appear in your list of available tools

Using with Claude

When using Claude in Cursor, you'll need to inform it that you have Logseq tools available with a prompt similar to:

"You have access to Logseq tools that can help you interact with my Logseq graph. You can use functions like logseq.get_all_pages(), logseq.get_page(name), logseq.create_page(name), etc."

Available Tools

All tools are available under the logseq namespace:

Pages

  • logseq.get_all_pages: Get a list of all pages in the Logseq graph

  • logseq.get_page: Get a specific page by name

  • logseq.create_page: Create a new page

  • logseq.delete_page: Delete a page and all its blocks

Blocks

  • logseq.get_page_blocks: Get all blocks from a specific page

  • logseq.get_block: Get a specific block by ID

  • logseq.create_block: Create a new block on a page

  • logseq.insert_block: Insert a block as a child of another block

  • logseq.update_block: Update an existing block

  • logseq.move_block: Move a block to a different location

  • logseq.remove_block: Remove a block and all its children

  • logseq.search_blocks: Search for blocks matching a query

Working with Logseq

Journal Pages

Journal pages in Logseq have a specific format and attributes:

  1. Use the format "mmm dth, yyyy" (e.g., "Apr 4th, 2025") when creating or accessing journal pages

  2. Journal pages are automatically formatted by Logseq with proper dating

  3. Journal pages have special attributes that are automatically set by Logseq:

    • journal?: true - Indicates this is a journal page

    • journalDay: YYYYMMDD - The date in numeric format (e.g., 20250404 for April 4, 2025)

  4. Example: await logseq.create_page("Apr 4th, 2025")

Important: You do not need to manually set the journal? or journalDay attributes. Simply creating a page with the proper date format (e.g., "Apr 4th, 2025") will automatically configure it as a journal page with the appropriate attributes.

Block Structure and Formatting

Blocks in Logseq have some important characteristics to understand:

  1. Automatic Bullets: All blocks are automatically rendered as bullet points in the Logseq UI

  2. Page Links: Create links using double brackets: [[Page Name]]

  3. Hierarchical Blocks:

    • Block structure data contains hierarchical information:

      • parent: The parent block's ID

      • level: The indentation level (1 for top-level, 2+ for indented blocks)

      • left: The block to the left (typically the parent for indented blocks)

  4. Block Content: When creating blocks, you can include text formatting:

    • Basic Markdown is supported (bold, italic, etc.)

    • Bullet points within a block may have limited support

    • Multi-line content is supported but may be subject to Logseq's parsing rules

  5. Journal Blocks: Blocks created in journal pages inherit special attributes:

    • journal?: true

    • journalDay: YYYYMMDD - Same as the journal page

Note: Like journal pages, these block attributes are automatically handled by Logseq. You don't need to manually set the journal? or journalDay attributes when creating blocks on journal pages.

Example Usage for Common Tasks

Working with the Cursor agent: When you have Logseq MCP tools configured in Cursor, you can give the agent prompts like:

  • "Create a new page called 'Meeting Notes' with bullet points for today's agenda"

  • "Add today's tasks to my journal page with a 'Tasks' section"

  • "Update today's journal entry with [[Project Plan]], set its child element to 'Completed milestone 1'"

  • "Search my graph for blocks about 'python projects' and organize them on a new page"

The agent will use the appropriate Logseq tools to carry out these operations on your graph.

Available Tools

13 tools
create_blockA
Creates a new block on a page in the Logseq graph.

IMPORTANT NOTES:
1. All blocks are automatically formatted as bullet points in Logseq UI
2. To create links to other pages, use double brackets: [[Page Name]]

When creating blocks on journal pages:
  - The block will inherit the "journal?" and "journalDay" attributes from the page
  - "journalDay" will be in YYYYMMDD format (e.g., 20250404 for April 4, 2025)

Args:
    page_name (str): The name of the page to create the block on.
    content (str): The content of the new block.
    properties (dict, optional): Properties to set on the new block.
    
Returns:
    dict: Information about the created block.

Inputs: page_name (required), content (required), properties.

create_pageA
Creates a new page in the Logseq graph.

For journal pages, use the format "mmm dth, yyyy" (e.g., "Apr 4th, 2025").
Journal pages are specially formatted in Logseq with automatic dating.

When you create a journal page, Logseq automatically:
- Sets "journal?": true
- Sets "journalDay": YYYYMMDD (e.g., 20250404 for April 4, 2025)
- Formats the page as a journal entry

Args:
    name (str): The name of the new page.
    properties (dict, optional): Properties to set on the new page.
    
Returns:
    dict: Information about the created page.

Inputs: name (required), properties.

delete_pageA
Deletes a page from the Logseq graph.

This operation removes the specified page and all its blocks. This action cannot be undone.

For journal pages, use the format "mmm dth, yyyy" (e.g., "Apr 4th, 2025").

Args:
    name (str): The name of the page to delete.
    
Returns:
    dict: Result of the deletion operation.

Inputs: name (required).

get_all_pagesA
Gets all pages from the Logseq graph.

Journal pages can be identified by the "journal?" attribute set to true and 
will include a "journalDay" attribute in the format YYYYMMDD.

Returns:
    list: A list of all pages in the Logseq graph.

Inputs: no named parameters.

get_blockA
Gets a specific block from the Logseq graph by its ID.

The returned block contains information about its hierarchical structure:
  - parent: The parent block's ID
  - level: The indentation level (1 for top-level, 2+ for indented blocks)
  - left: The block to the left (typically the parent for indented blocks)

If the block is from a journal page, it will include:
  - "journal?": true
  - "journalDay": YYYYMMDD - Date in numeric format

Args:
    block_id (str): The ID of the block to retrieve.
    
Returns:
    dict: Information about the requested block.

Inputs: block_id (required).

get_pageA
Gets a specific page from the Logseq graph by name.

For journal pages, use the format "mmm dth, yyyy" (e.g., "Apr 4th, 2025").
Note that journal pages are automatically created in Logseq with this date format.

Journal pages have specific attributes:
- "journal?": true - Indicates this is a journal page
- "journalDay": YYYYMMDD - The date in numeric format (e.g., 20250404 for April 4, 2025)

Args:
    name (str): The name of the page to retrieve.
    
Returns:
    dict: Information about the requested page.

Inputs: name (required).

get_page_blocksA
Gets all blocks from a specific page in the Logseq graph.

For journal pages, use the format "mmm dth, yyyy" (e.g., "Apr 4th, 2025").
Returned blocks contain information about their hierarchical structure:
  - parent: The parent block's ID
  - level: The indentation level (1 for top-level, 2+ for indented blocks)
  - left: The block to the left (typically the parent for indented blocks)

Blocks from journal pages will have:
  - "journal?": true
  - "journalDay": YYYYMMDD - The date in numeric format (e.g., 20250404)

Args:
    page_name (str): The name of the page to retrieve blocks from.
    
Returns:
    list: A list of blocks from the specified page.

Inputs: page_name (required).

get_page_linked_referencesA
Gets all linked references to a specific page in the Logseq graph.

This returns blocks that contain links to the specified page using
the Logseq double bracket notation: [[Page Name]].

For journal pages, use the format "mmm dth, yyyy" (e.g., "Apr 4th, 2025").

Args:
    page_name (str): The name of the page to find references to.
    
Returns:
    list: A list of blocks that reference the specified page.

Inputs: page_name (required).

insert_blockA
Inserts a new block as a child of the specified parent block.

This allows for creating hierarchical content by adding children to existing blocks.

IMPORTANT NOTES:
1. All blocks are automatically formatted as bullet points in Logseq UI
2. To create links to other pages, use double brackets: [[Page Name]]
3. The new block will be inserted at the beginning or end of the parent's children
   depending on the 'before' parameter

When inserting blocks into journal pages:
  - The block will inherit the "journal?" and "journalDay" attributes
  - "journalDay" will be in YYYYMMDD format (e.g., 20250404 for April 4, 2025)

Args:
    parent_block_id (str): The ID of the parent block to insert under.
    content (str): The content of the new block.
    properties (dict, optional): Properties to set on the new block.
    before (bool, optional): Whether to insert at the beginning of children. 
                            Default is False (append at the end).
    
Returns:
    dict: Information about the created block.

Inputs: parent_block_id (required), content (required), properties, before.

move_blockA
Moves a block to a new location in the graph.

This allows for reorganizing the structure of blocks in the graph by moving
a block (and all its children) to a different location.

IMPORTANT NOTES:
1. The block will maintain its children when moved
2. The hierarchical position depends on the 'as_child' parameter:
   - If as_child=True: The block becomes a child of the target block
   - If as_child=False: The block becomes a sibling after the target block

Args:
    block_id (str): The ID of the block to move.
    target_block_id (str): The ID of the target block to move to.
    as_child (bool, optional): Whether to make the block a child of the target.
                              Default is False (insert as sibling).
    
Returns:
    dict: Result of the move operation.

Inputs: block_id (required), target_block_id (required), as_child.

remove_blockA
Removes a block from the Logseq graph.

This operation permanently removes the specified block and all its children.
This action cannot be undone.

To remove a block, you need its block ID, which can be obtained from:
- get_page_blocks() function
- get_block() function
- search_blocks() function

Args:
    block_id (str): The ID of the block to remove.
    
Returns:
    dict: Result of the removal operation.

Inputs: block_id (required).

search_blocksA
Searches for blocks matching a query in the Logseq graph.

Examples of useful queries:
- page:"Page Name" - find all blocks on a specific page
- "search term" - find blocks containing the term
- page:"Apr 4th, 2025" - find all blocks in a journal
- [[Page Name]] - find references to a specific page

Returned blocks from journal pages will include:
- "journal?": true
- "journalDay": YYYYMMDD - The date in numeric format

Args:
    query (str): The search query.
    
Returns:
    list: A list of blocks matching the search query.

Inputs: query (required).

update_blockA
Updates an existing block in the Logseq graph.

IMPORTANT NOTES:
1. All blocks are automatically formatted as bullet points in Logseq UI
2. To create links to other pages, use double brackets: [[Page Name]]

When updating blocks on journal pages:
  - The "journal?" and "journalDay" attributes will be preserved
  - "journalDay" will remain in YYYYMMDD format (e.g., 20250404)

Args:
    block_id (str): The ID of the block to update.
    content (str): The new content for the block.
    properties (dict, optional): Properties to update on the block.
    
Returns:
    dict: Information about the updated block.

Inputs: block_id (required), content (required), properties.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

Loading tool schema changelog…

    Deploy Server
    One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

    TDQS

    A4.3/5.0

    Scored across 13 tools

    Disambiguation5/5

    Each tool has a clearly distinct purpose with no overlap. For example, create_block and insert_block serve different functions (creating a block on a page vs. inserting a block as a child), and get_page_blocks and search_blocks target different retrieval methods. The descriptions reinforce these distinctions, making misselection unlikely.

    Naming Consistency5/5

    All tool names follow a consistent verb_noun pattern with snake_case, such as create_block, get_page, and update_block. This uniformity makes the tool set predictable and easy to navigate, with no deviations in naming conventions.

    Tool Count5/5

    With 13 tools, the set is well-scoped for managing a Logseq graph, covering essential operations like CRUD for pages and blocks, hierarchical manipulation, and search. Each tool serves a clear purpose without redundancy, making the count appropriate for the domain.

    Completeness5/5

    The tool set provides comprehensive coverage for Logseq graph management, including full CRUD for pages and blocks, hierarchical operations (move_block, insert_block), retrieval methods (get_all_pages, search_blocks), and advanced features like linked references. There are no obvious gaps that would hinder agent workflows.

    Resources

    Related MCP Connectors

    Related MCP Servers