Skip to main content
Glama
zoeynine

Obsidian Server MCP

by zoeynine

reference_query

Read-onlyIdempotent

Find references to a note, heading, or block within defined source and resolution scopes, returning matches, uncertainties, and exact source versions for read-only link analysis.

Instructions

Find references to a file/heading/block within explicit source and resolution scopes. Read-only; returns matches plus uncertainties and exact source versions. Outside-scope incoming links remain unknown. See help topic references.

Input Schema

NameRequiredDescriptionDefault
scopeYes
targetYes
maxFilesNo
maxEntriesNo
maxResultsNo
maxFileBytesNo
maxTotalBytesNo
maxOutputBytesNo
resolutionScopeNo

Output Schema

NameRequiredDescriptionDefault
scopeYes
targetYes
matchesYes
coverageYes
uncertainYes
resolutionScopeYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed9 schema fields changedv0.2.0
    • addedOutput schema / properties / matches / items / properties / source / properties / versionGuard
      Added value: +{
      +  "maxLength": 16,
      +  "minLength": 16,
      +  "pattern": "^[0-9a-f]{16}$",
      +  "type": "string"
      +}
    • changedOutput schema / properties / matches / items / properties / source / required
      Previous value: -[
      -  "path",
      -  "version"
      -]New value: +[
      +  "path",
      +  "version",
      +  "versionGuard"
      +]
    • removedOutput schema / properties / target / additionalProperties
      Removed value: -false
    • addedOutput schema / properties / target / anyOf
      Added value: +[
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "block": {
      +        "pattern": "^[a-zA-Z0-9-]+$",
      +        "type": "string"
      +      },
      +      "fileExists": {
      +        "type": "boolean"
      +      },
      +      "heading": {
      +        "items": {
      +          "maxLength": 1024,
      +          "minLength": 1,
      +          "type": "string"
      +        },
      +        "maxItems": 32,
      +        "minItems": 1,
      +        "type": "array"
      +      },
      +      "path": {
      +        "type": "string"
      +      },
      +      "reason": {
      +        "type": "string"
      +      },
      +      "status": {
      +        "enum": [
      +          "resolved",
      +          "ambiguous",
      +          "unresolved",
      +          "unsupported",
      +          "unknown"
      +        ],
      +        "type": "string"
      +      },
      +      "version": {
      +        "pattern": "^sha256:[0-9a-f]{64}$",
      +        "type": "string"
      +      },
      +      "versionGuard": {
      +        "maxLength": 16,
      +        "minLength": 16,
      +        "pattern": "^[0-9a-f]{16}$",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "path",
      +      "fileExists",
      +      "status",
      +      "reason",
      +      "version",
      +      "versionGuard"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "block": {
      +        "pattern": "^[a-zA-Z0-9-]+$",
      +        "type": "string"
      +      },
      +      "fileExists": {
      +        "type": "boolean"
      +      },
      +      "heading": {
      +        "items": {
      +          "maxLength": 1024,
      +          "minLength": 1,
      +          "type": "string"
      +        },
      +        "maxItems": 32,
      +        "minItems": 1,
      +        "type": "array"
      +      },
      +      "path": {
      +        "type": "string"
      +      },
      +      "reason": {
      +        "type": "string"
      +      },
      +      "status": {
      +        "enum": [
      +          "resolved",
      +          "ambiguous",
      +          "unresolved",
      +          "unsupported",
      +          "unknown"
      +        ],
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "path",
      +      "fileExists",
      +      "status",
      +      "reason"
      +    ],
      +    "type": "object"
      +  }
      +]
    • removedOutput schema / properties / target / properties
      Removed value: -{
      -  "block": {
      -    "pattern": "^[a-zA-Z0-9-]+$",
      -    "type": "string"
      -  },
      -  "fileExists": {
      -    "type": "boolean"
      -  },
      -  "heading": {
      -    "items": {
      -      "maxLength": 1024,
      -      "minLength": 1,
      -      "type": "string"
      -    },
      -    "maxItems": 32,
      -    "minItems": 1,
      -    "type": "array"
      -  },
      -  "path": {
      -    "type": "string"
      -  },
      -  "reason": {
      -    "type": "string"
      -  },
      -  "status": {
      -    "enum": [
      -      "resolved",
      -      "ambiguous",
      -      "unresolved",
      -      "unsupported",
      -      "unknown"
      -    ],
      -    "type": "string"
      -  },
      -  "version": {
      -    "type": "string"
      -  }
      -}
    • removedOutput schema / properties / target / required
      Removed value: -[
      -  "path",
      -  "fileExists",
      -  "status",
      -  "reason"
      -]
    • removedOutput schema / properties / target / type
      Removed value: -"object"
    • addedOutput schema / properties / uncertain / items / properties / source / properties / versionGuard
      Added value: +{
      +  "maxLength": 16,
      +  "minLength": 16,
      +  "pattern": "^[0-9a-f]{16}$",
      +  "type": "string"
      +}
    • changedOutput schema / properties / uncertain / items / properties / source / required
      Previous value: -[
      -  "path",
      -  "version"
      -]New value: +[
      +  "path",
      +  "version",
      +  "versionGuard"
      +]
  2. First observedv0.1.0

TDQS

A3.5/5.0
Behavior4/5

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

Annotations already cover the read-only/idempotent safety profile, so the description earns credit for adding beyond them: it discloses that results include 'uncertainties and exact source versions' and that out-of-scope links are silently omitted—non-obvious behaviors an agent needs.

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?

Three tight sentences with the core operation front-loaded, the key limitation second, and a pointer to help last. Nothing is redundant.

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

Completeness3/5

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

An output schema exists, so return shape needn't be explained, and annotations cover safety. But for a 9-parameter tool with nested scopes and 0% schema coverage, the description leaves the limit parameters and their interaction with results unexplained, a real gap for correct invocation.

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

Parameters2/5

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

Schema description coverage is 0% across 9 parameters, including nested objects. The description maps the conceptual source/resolution scope and target dimensions, but the six max* limit parameters and the recursive flags are never explained, leaving most of the schema meaning undocumented.

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

Purpose4/5

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

Specific verb ('Find references') plus resource ('file/heading/block') and the scoping model make the operation unambiguous. It does not explicitly contrast with siblings like search_query, but the 'references' framing distinguishes it well enough.

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

Usage Guidelines3/5

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

The caveat 'Outside-scope incoming links remain unknown' implies when results are incomplete, and 'See help topic references' routes to more detail. However, it never states when to prefer this over search_query or other siblings, leaving usage largely inferred.

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