Roam Research

// Tool definitions and input schemas for Roam Research MCP server export const toolSchemas = { roam_add_todo: { name: 'roam_add_todo', description: 'Add a list of todo items as individual blocks to today\'s daily page in Roam. Each item becomes its own actionable block with todo status.\nNOTE on Roam-flavored markdown: For direct linking: use [[link]] syntax. For aliased linking, use [alias]([[link]]) syntax. Do not concatenate words in links/hashtags - correct: #[[multiple words]] #self-esteem (for typically hyphenated words).\nIMPORTANT: Before using this tool, ensure that you have loaded into context the \'Roam Markdown Cheatsheet\' resource.', inputSchema: { type: 'object', properties: { todos: { type: 'array', items: { type: 'string', description: 'Todo item text' }, description: 'List of todo items to add' } }, required: ['todos'], }, }, roam_fetch_page_by_title: { name: 'roam_fetch_page_by_title', description: 'Fetch page by title. Returns content in the specified format.', inputSchema: { type: 'object', properties: { title: { type: 'string', description: 'Title of the page. For date pages, use ordinal date formats such as January 2nd, 2025' }, format: { type: 'string', enum: ['markdown', 'raw'], default: 'raw', description: "Format output as markdown or JSON. 'markdown' returns as string; 'raw' returns JSON string of the page's blocks" } }, required: ['title'] }, }, roam_create_page: { name: 'roam_create_page', description: 'Create a new standalone page in Roam with optional content, including structured outlines, using explicit nesting levels and headings (H1-H3). This is the preferred method for creating a new page with an outline in a single step. Best for:\n- Creating foundational concept pages that other pages will link to/from\n- Establishing new topic areas that need their own namespace\n- Setting up reference materials or documentation\n- Making permanent collections of information.\nIMPORTANT: Before using this tool, ensure that you have loaded into context the \'Roam Markdown Cheatsheet\' resource.', inputSchema: { type: 'object', properties: { title: { type: 'string', description: 'Title of the new page', }, content: { type: 'array', description: 'Initial content for the page as an array of blocks with explicit nesting levels. Note: While empty blocks (e.g., {"text": "", "level": 1}) can be used for visual spacing, they create empty entities in the database. Please use them sparingly and only for structural purposes, not for simple visual separation.', items: { type: 'object', properties: { text: { type: 'string', description: 'Content of the block' }, level: { type: 'integer', description: 'Indentation level (1-10, where 1 is top level)', minimum: 1, maximum: 10 }, heading: { type: 'integer', description: 'Optional: Heading formatting for this block (1-3)', minimum: 1, maximum: 3 } }, required: ['text', 'level'] } }, }, required: ['title'], }, }, roam_create_outline: { name: 'roam_create_outline', description: 'Add a structured outline to an existing page or block (by title text or uid), with customizable nesting levels. To create a new page with an outline, use the `roam_create_page` tool instead. The `outline` parameter defines *new* blocks to be created. To nest content under an *existing* block, provide its UID or exact text in `block_text_uid`, and ensure the `outline` array contains only the child blocks with levels relative to that parent. Including the parent block\'s text in the `outline` array will create a duplicate block. Best for:\n- Adding supplementary structured content to existing pages\n- Creating temporary or working outlines (meeting notes, brainstorms)\n- Organizing thoughts or research under a specific topic\n- Breaking down subtopics or components of a larger concept\nBest for simpler, contiguous hierarchical content. For complex nesting (e.g., tables) or granular control over block placement, consider `roam_process_batch_actions` instead.\nIMPORTANT: Before using this tool, ensure that you have loaded into context the \'Roam Markdown Cheatsheet\' resource.', inputSchema: { type: 'object', properties: { page_title_uid: { type: 'string', description: 'Title or UID of the page (UID is preferred for accuracy). Leave blank to use the default daily page.' }, block_text_uid: { type: 'string', description: 'The text content or UID of the block to nest the outline under (UID is preferred for accuracy). If blank, content is nested directly under the page (or the default daily page if page_title_uid is also blank).' }, outline: { type: 'array', description: 'Array of outline items with block text and explicit nesting level. Must be a valid hierarchy: the first item must be level 1, and subsequent levels cannot increase by more than 1 at a time (e.g., a level 3 cannot follow a level 1).', items: { type: 'object', properties: { text: { type: 'string', description: 'Content of the block' }, level: { type: 'integer', description: 'Indentation level (1-10, where 1 is top level). Levels must be sequential and cannot be skipped (e.g., a level 3 item cannot directly follow a level 1 item).', minimum: 1, maximum: 10 }, heading: { type: 'integer', description: 'Optional: Heading formatting for this block (1-3)', minimum: 1, maximum: 3 }, children_view_type: { type: 'string', description: 'Optional: The view type for children of this block ("bullet", "document", or "numbered")', enum: ["bullet", "document", "numbered"] } }, required: ['text', 'level'] } } }, required: ['outline'] } }, roam_import_markdown: { name: 'roam_import_markdown', description: 'Import nested markdown content into Roam under a specific block. Can locate the parent block by UID (preferred) or by exact string match within a specific page. If a `parent_string` is provided and the block does not exist, it will be created. Returns a nested structure of the created blocks.\nIMPORTANT: Before using this tool, ensure that you have loaded into context the \'Roam Markdown Cheatsheet\' resource.', inputSchema: { type: 'object', properties: { content: { type: 'string', description: 'Nested markdown content to import' }, page_uid: { type: 'string', description: 'Optional: UID of the page containing the parent block (preferred for accuracy).' }, page_title: { type: 'string', description: 'Optional: Title of the page containing the parent block (used if page_uid is not provided).' }, parent_uid: { type: 'string', description: 'Optional: UID of the parent block to add content under (preferred for accuracy).' }, parent_string: { type: 'string', description: 'Optional: Exact string content of an existing parent block to add content under (used if parent_uid is not provided; requires page_uid or page_title). If the block does not exist, it will be created.' }, order: { type: 'string', description: 'Optional: Where to add the content undeIs this tr the parent ("first" or "last")', enum: ['first', 'last'], default: 'first' } }, required: ['content'] } }, roam_search_for_tag: { name: 'roam_search_for_tag', description: 'Search for blocks containing a specific tag and optionally filter by blocks that also contain another tag nearby or exclude blocks with a specific tag. This tool supports pagination via the `limit` and `offset` parameters. Use this tool to search for memories tagged with the MEMORIES_TAG.', inputSchema: { type: 'object', properties: { primary_tag: { type: 'string', description: 'The main tag to search for (without the [[ ]] brackets)', }, page_title_uid: { type: 'string', description: 'Optional: Title or UID of the page to search in (UID is preferred for accuracy). Defaults to today\'s daily page if not provided.', }, near_tag: { type: 'string', description: 'Optional: Another tag to filter results by - will only return blocks where both tags appear', }, case_sensitive: { type: 'boolean', description: 'Optional: Whether the search should be case-sensitive. If false, it will search for the provided tag, capitalized versions, and first word capitalized versions.', default: false }, limit: { type: 'integer', description: 'Optional: The maximum number of results to return. Defaults to 50. Use -1 for no limit, but be aware that very large results sets can impact performance.', default: 50 }, offset: { type: 'integer', description: 'Optional: The number of results to skip before returning matches. Useful for pagination. Defaults to 0.', default: 0 } }, required: ['primary_tag'] } }, roam_search_by_status: { name: 'roam_search_by_status', description: 'Search for blocks with a specific status (TODO/DONE) across all pages or within a specific page.', inputSchema: { type: 'object', properties: { status: { type: 'string', description: 'Status to search for (TODO or DONE)', enum: ['TODO', 'DONE'] }, page_title_uid: { type: 'string', description: 'Optional: Title or UID of the page to search in (UID is preferred for accuracy). If not provided, searches across all pages.' }, include: { type: 'string', description: 'Optional: Comma-separated list of terms to filter results by inclusion (matches content or page title)' }, exclude: { type: 'string', description: 'Optional: Comma-separated list of terms to filter results by exclusion (matches content or page title)' } }, required: ['status'] } }, roam_search_block_refs: { name: 'roam_search_block_refs', description: 'Search for block references within a page or across the entire graph. Can search for references to a specific block or find all block references.', inputSchema: { type: 'object', properties: { block_uid: { type: 'string', description: 'Optional: UID of the block to find references to' }, page_title_uid: { type: 'string', description: 'Optional: Title or UID of the page to search in (UID is preferred for accuracy). If not provided, searches across all pages.' } } } }, roam_search_hierarchy: { name: 'roam_search_hierarchy', description: 'Search for parent or child blocks in the block hierarchy. Can search up or down the hierarchy from a given block.', inputSchema: { type: 'object', properties: { parent_uid: { type: 'string', description: 'Optional: UID of the block to find children of' }, child_uid: { type: 'string', description: 'Optional: UID of the block to find parents of' }, page_title_uid: { type: 'string', description: 'Optional: Title or UID of the page to search in (UID is preferred for accuracy).' }, max_depth: { type: 'integer', description: 'Optional: How many levels deep to search (default: 1)', minimum: 1, maximum: 10 } } // Note: Validation for either parent_uid or child_uid is handled in the server code } }, roam_find_pages_modified_today: { name: 'roam_find_pages_modified_today', description: 'Find pages that have been modified today (since midnight), with pagination and sorting options.', inputSchema: { type: 'object', properties: { limit: { type: 'integer', description: 'The maximum number of pages to retrieve (default: 50). Use -1 for no limit, but be aware that very large result sets can impact performance.', default: 50 }, offset: { type: 'integer', description: 'The number of pages to skip before returning matches. Useful for pagination. Defaults to 0.', default: 0 }, sort_order: { type: 'string', description: 'Sort order for pages based on modification date. "desc" for most recent first, "asc" for oldest first.', enum: ['asc', 'desc'], default: 'desc' } } } }, roam_search_by_text: { name: 'roam_search_by_text', description: 'Search for blocks containing specific text across all pages or within a specific page. This tool supports pagination via the `limit` and `offset` parameters.', inputSchema: { type: 'object', properties: { text: { type: 'string', description: 'The text to search for' }, page_title_uid: { type: 'string', description: 'Optional: Title or UID of the page to search in (UID is preferred for accuracy). If not provided, searches across all pages.' }, case_sensitive: { type: 'boolean', description: 'Optional: Whether the search should be case-sensitive. If false, it will search for the provided text, capitalized versions, and first word capitalized versions.', default: false }, limit: { type: 'integer', description: 'Optional: The maximum number of results to return. Defaults to 50. Use -1 for no limit, but be aware that very large results sets can impact performance.', default: 50 }, offset: { type: 'integer', description: 'Optional: The number of results to skip before returning matches. Useful for pagination. Defaults to 0.', default: 0 } }, required: ['text'] } }, roam_search_by_date: { name: 'roam_search_by_date', description: 'Search for blocks or pages based on creation or modification dates. Not for daily pages with ordinal date titles.', inputSchema: { type: 'object', properties: { start_date: { type: 'string', description: 'Start date in ISO format (YYYY-MM-DD)', }, end_date: { type: 'string', description: 'Optional: End date in ISO format (YYYY-MM-DD)', }, type: { type: 'string', enum: ['created', 'modified', 'both'], description: 'Whether to search by creation date, modification date, or both', }, scope: { type: 'string', enum: ['blocks', 'pages', 'both'], description: 'Whether to search blocks, pages', }, include_content: { type: 'boolean', description: 'Whether to include the content of matching blocks/pages', default: true, } }, required: ['start_date', 'type', 'scope'] } }, roam_markdown_cheatsheet: { name: 'roam_markdown_cheatsheet', description: 'Provides the content of the Roam Markdown Cheatsheet resource, optionally concatenated with custom instructions if CUSTOM_INSTRUCTIONS_PATH is set.', inputSchema: { type: 'object', properties: {}, required: [], }, }, roam_remember: { name: 'roam_remember', description: 'Add a memory or piece of information to remember, stored on the daily page with MEMORIES_TAG tag and optional categories. \nNOTE on Roam-flavored markdown: For direct linking: use [[link]] syntax. For aliased linking, use [alias]([[link]]) syntax. Do not concatenate words in links/hashtags - correct: #[[multiple words]] #self-esteem (for typically hyphenated words).\nIMPORTANT: Before using this tool, ensure that you have loaded into context the \'Roam Markdown Cheatsheet\' resource.', inputSchema: { type: 'object', properties: { memory: { type: 'string', description: 'The memory detail or information to remember' }, categories: { type: 'array', items: { type: 'string' }, description: 'Optional categories to tag the memory with (will be converted to Roam tags)' } }, required: ['memory'] } }, roam_recall: { name: 'roam_recall', description: 'Retrieve all stored memories on page titled MEMORIES_TAG, or tagged block content with the same name. Returns a combined, deduplicated list of memories. Optionally filter blcoks with a specific tag and sort by creation date.', inputSchema: { type: 'object', properties: { sort_by: { type: 'string', description: 'Sort order for memories based on creation date', enum: ['newest', 'oldest'], default: 'newest' }, filter_tag: { type: 'string', description: 'Include only memories with a specific filter tag. For single word tags use format "tag", for multi-word tags use format "tag word" (without brackets)' } } } }, roam_datomic_query: { name: 'roam_datomic_query', description: 'Execute a custom Datomic query on the Roam graph for advanced data retrieval beyond the available search tools. This provides direct access to Roam\'s query engine. Note: Roam graph is case-sensitive.\n\n__Optimal Use Cases for `roam_datomic_query`:__\n- __Advanced Filtering (including Regex):__ Use for scenarios requiring complex filtering, including regex matching on results post-query, which Datalog does not natively support for all data types. It can fetch broader results for client-side post-processing.\n- __Highly Complex Boolean Logic:__ Ideal for intricate combinations of "AND", "OR", and "NOT" conditions across multiple terms or attributes.\n- __Arbitrary Sorting Criteria:__ The go-to for highly customized sorting needs beyond default options.\n- __Proximity Search:__ For advanced search capabilities involving proximity, which are difficult to implement efficiently with simpler tools.\n\nList of some of Roam\'s data model Namespaces and Attributes: ancestor (descendants), attrs (lookup), block (children, heading, open, order, page, parents, props, refs, string, text-align, uid), children (view-type), create (email, time), descendant (ancestors), edit (email, seen-by, time), entity (attrs), log (id), node (title), page (uid, title), refs (text).\nPredicates (clojure.string/includes?, clojure.string/starts-with?, clojure.string/ends-with?, <, >, <=, >=, =, not=, !=).\nAggregates (distinct, count, sum, max, min, avg, limit).\nTips: Use :block/parents for all ancestor levels, :block/children for direct descendants only; combine clojure.string for complex matching, use distinct to deduplicate, leverage Pull patterns for hierarchies, handle case-sensitivity carefully, and chain ancestry rules for multi-level queries.', inputSchema: { type: 'object', properties: { query: { type: 'string', description: 'The Datomic query to execute (in Datalog syntax). Example: `[:find ?block-string :where [?block :block/string ?block-string] (or [(clojure.string/includes? ?block-string "hypnosis")] [(clojure.string/includes? ?block-string "trance")] [(clojure.string/includes? ?block-string "suggestion")]) :limit 25]`' }, inputs: { type: 'array', description: 'Optional array of input parameters for the query', items: { type: 'string' } }, regexFilter: { type: 'string', description: 'Optional: A regex pattern to filter the results client-side after the Datomic query. Applied to JSON.stringify(result) or specific fields if regexTargetField is provided.' }, regexFlags: { type: 'string', description: 'Optional: Flags for the regex filter (e.g., "i" for case-insensitive, "g" for global).', }, regexTargetField: { type: 'array', items: { type: 'string' }, description: 'Optional: An array of field paths (e.g., ["block_string", "page_title"]) within each Datomic result object to apply the regex filter to. If not provided, the regex is applied to the stringified full result.' } }, required: ['query'] } }, roam_process_batch_actions: { name: 'roam_process_batch_actions', description: 'Executes a sequence of low-level block actions (create, update, move, delete) in a single, non-transactional batch. Actions are executed in the provided order. For creating nested blocks, you can use a temporary client-side UID in a parent block and refer to it in a child block within the same batch. For actions on existing blocks, a valid block UID is required. Note: Roam-flavored markdown, including block embedding with `((UID))` syntax, is supported within the `string` property for `create-block` and `update-block` actions. For actions on existing blocks or within a specific page context, it is often necessary to first obtain valid page or block UIDs. Tools like `roam_fetch_page_by_title` or other search tools can be used to retrieve these UIDs before executing batch actions. For simpler, sequential outlines, `roam_create_outline` is often more suitable.\nIMPORTANT: Before using this tool, ensure that you have loaded into context the \'Roam Markdown Cheatsheet\' resource.', inputSchema: { type: 'object', properties: { actions: { type: 'array', description: 'An array of action objects to execute in order.', items: { type: 'object', properties: { "action": { type: 'string', description: 'The specific action to perform.', enum: ['create-block', 'update-block', 'move-block', 'delete-block'] }, "uid": { type: 'string', description: 'The UID of the block to target for "update-block", "move-block", or "delete-block" actions.' }, "string": { type: 'string', description: 'The content for the block, used in "create-block" and "update-block" actions.' }, "open": { type: "boolean", description: "Optional: Sets the open/closed state of a block, used in 'update-block' or 'create-block'. Defaults to true." }, "heading": { type: "integer", description: "Optional: The heading level (1, 2, or 3) for 'create-block' or 'update-block'.", enum: [1, 2, 3] }, "text-align": { type: "string", description: "Optional: The text alignment for 'create-block' or 'update-block'.", enum: ["left", "center", "right", "justify"] }, "children-view-type": { type: "string", description: "Optional: The view type for children of the block, for 'create-block' or 'update-block'.", enum: ["bullet", "document", "numbered"] }, "location": { type: 'object', description: 'Specifies where to place a block, used in "create-block" and "move-block" actions.', properties: { "parent-uid": { type: 'string', description: 'The UID of the parent block or page.' }, "order": { type: ['integer', 'string'], description: 'The position of the block under its parent (e.g., 0, 1, 2) or a keyword ("first", "last").' } } } }, required: ['action'] } } }, required: ['actions'] } }, roam_fetch_block_with_children: { name: 'roam_fetch_block_with_children', description: 'Fetch a block by its UID along with its hierarchical children down to a specified depth. Returns a nested object structure containing the block\'s UID, text, order, and an array of its children.', inputSchema: { type: 'object', properties: { block_uid: { type: 'string', description: 'The UID of the block to fetch.' }, depth: { type: 'integer', description: 'Optional: The number of levels deep to fetch children. Defaults to 4.', minimum: 0, maximum: 10 } }, required: ['block_uid'] }, }, };