Skip to main content
Glama

Promote Node To Note

promote_node_to_note

Converts a codebase graph node into a curated Obsidian note, pre-filled with its neighboring files, symbols, or features and marked as an assumed skeleton for review.

Instructions

Materialize a graph node (file/symbol/feature) as a curated note under 20-Knowledge/codebase/{files,symbols,features}, pre-filled with its neighbors from the graph. Written as status:"assumed" (it is a skeleton, not verified prose) -- promote sparingly, per Instructions.md Sec.12: not every file earns a note.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
bodyNo
vaultNo
node_idYes
extra_frontmatterNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.1/5.0
Behavior4/5

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

No annotations, so description carries full burden. It discloses that the note is pre-filled with graph neighbors and written as status:'assumed' (skeleton, not verified), which is important behavioral context. It doesn't cover permissions or return value, though an output schema exists.

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

Conciseness4/5

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

Compact, front-loaded with the core action and destination, followed by behavioral caveat and usage note. No filler, but slightly dense with inline references.

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?

Output schema exists, so return values need not be explained. For a mutation tool without annotations, the description covers key behavior (auto-fill, assumed status) and usage restraint, but leaves parameter meanings vague and doesn't state permissions or side effects on the graph.

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 coverage is 0% for 4 parameters, so the schema does not describe them. Description only implicitly names node (graph node) and body (prose, implied not verified). vault, extra_frontmatter, and body semantics are not explained, so it does not compensate for the coverage gap.

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?

States a specific verb (materialize/promote) and resource (graph node -> curated note) with precise output location (20-Knowledge/codebase/{files,symbols,features}). Clearly distinguishable from write_note (writing prose) and upsert_node (graph mutation).

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?

Provides explicit guidance on when to use: 'promote sparingly, per Instructions.md Sec.12: not every file earns a note.' Gives a usage posture but doesn't name a direct alternative or a when-not condition beyond scarcity.

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