Skip to main content
Glama
Sign In
obsidian-mcp-pro

obsidian-mcp-pro

by rps321321
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

Find Broken Links

find_broken_links
Read-onlyIdempotent

Scan notes for wikilinks that do not resolve in the vault and return a per-source report of broken link text, line numbers, and totals to catch dangling references after renames, moves, or deletions.

Instructions

Scan notes for wikilinks ([[target]]) whose target does not resolve to any existing note in the vault. Returns a per-source report grouping each note with its broken link text and line numbers, plus a total count. Use after renaming, moving, or deleting notes to catch dangling references. Resolution uses the whole vault even when scanning a single folder, so only truly unresolvable links are reported.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "find_broken_links"
  }
}

Input Schema

NameRequiredDescriptionDefault
folderNoRestrict the scan to notes within this folder (resolution still uses the entire vault). Omit to scan every note.
maxResultsNoMaximum broken link entries to show (1-1000, default: 200). Grouped by source note. Remaining matches are summarized.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv4.1.1
    • removedInput schema / additionalProperties
      Removed value: -false
  2. Addedv2.0.0
  3. Removedv1.9.0
  4. Addedv0.1.6
  5. Removedv0.1.4
  6. Changed5 schema fields changedv0.1.2
    • changedInput schema / properties / folder / description
      Previous value: -"Limit scan to a specific folder"New value: +"Restrict the scan to notes within this folder (resolution still uses the entire vault). Omit to scan every note."
    • changedInput schema / properties / maxResults / description
      Previous value: -"Maximum results to return"New value: +"Maximum broken link entries to show (1-5000, default: 200). Grouped by source note. Remaining matches are summarized."
    • addedInput schema / properties / maxResults / maximum
      Added value: +5000
    • addedInput schema / properties / maxResults / minimum
      Added value: +1
    • changedInput schema / properties / maxResults / type
      Previous value: -"number"New value: +"integer"
  7. First observedv0.1.0

TDQS

A4.5/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already establish that this is a read-only, idempotent, closed-world operation. The description adds meaningful behavioral details beyond annotations: per-source grouping, broken link text and line numbers, total count, and the whole-vault resolution rule even when scanning a folder.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is front-loaded with the core purpose and then adds return format and usage timing without waste. Every sentence contributes useful information for invoking or interpreting the tool.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

There is no output schema, but the description sufficiently explains the return structure: a per-source report with broken link text, line numbers, and a total count. Together with the annotated safety profile and fully described parameters, it is complete enough for correct use.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so both folder and maxResults are already well documented. The description reinforces the whole-vault resolution behavior for folder scanning but does not add syntax or constraints beyond what the schema provides, making the baseline 3 appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb and resource: scanning notes for wikilinks whose targets do not resolve to existing notes. It also distinguishes the behavior from related tools by explaining that resolution uses the whole vault and that only truly unresolvable links are reported.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It gives a clear usage situation: after renaming, moving, or deleting notes to catch dangling references. It does not explicitly name alternatives such as get_outlinks or find_orphans, nor does it state when not to use this tool, so it falls short of full alternative guidance.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools