Skip to main content
Glama

find_orphans

Read-only

Identify docs that no other node references via any frontmatter array key, providing a cleanup starting point or answering which nodes are unused.

Instructions

List orphan nodes — docs that no other node references via any frontmatter array key. Useful as a cleanup starting point or to answer "which nodes are unused?". Same matching policy as find_backlinks (full slug or final segment). Root/sentinel kinds like project and vault-readme are excluded by default.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
kindNoRestrict to one kind (e.g. capability). Omit for all kinds.
excludeKindsNoKinds to exclude from results. Defaults to ['project', 'vault-readme']. Pass [] to include every kind. Typos fail with nearest-value hints.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
totalYes
orphansYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.13.0

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is covered. The description adds meaningful behavioral details beyond that: the default exclusion of root/sentinel kinds and the specific matching policy (full slug or final segment). This enriches the agent's understanding without contradicting the annotations.

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 three sentences, front-loaded with the core purpose, and every sentence adds value: the definition, the use cases, and the matching policy plus default exclusions. There is zero waste or redundancy.

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

Completeness4/5

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

For a read-only list tool with a full output schema, the description covers the essential purpose, use cases, matching policy, and default exclusions. It doesn't describe the output format, but that is handled by the output schema. The only minor gap is that it doesn't explicitly mention pagination or performance, but these are not critical for a tool like this.

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% – both 'kind' and 'excludeKinds' have descriptive text in the schema, including the default value for excludeKinds. The tool description reinforces the default exclusion but does not add new parameter-specific meaning beyond what the schema already provides. Given the high schema coverage, the baseline of 3 applies.

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 clearly states the tool's purpose: 'List orphan nodes' and defines exactly what an orphan node is ('docs that no other node references via any frontmatter array key'). It also distinguishes itself from the sibling find_backlinks by referencing the same matching policy, so an agent can differentiate them without inspecting schemas.

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?

The description gives a clear use case ('cleanup starting point' and 'which nodes are unused?') and explicitly notes that the matching policy is shared with find_backlinks, which implicitly tells an agent that find_backlinks is the counterpart for finding referenced nodes. However, it doesn't explicitly state when not to use this tool or name alternative tools for different scenarios, so it's slightly short of a 5.

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