annotate

Add, store, and retrieve sidecar annotations on Compass vault files in JSON format.

Updated Aug 27, 2026
One-click install
npx skills add https://github.com/hodor/claude-compass --skill annotate-hodor
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: annotate
Source: https://github.com/hodor/claude-compass/tree/main/plugin/skills/annotate
Command: npx skills add https://github.com/hodor/claude-compass --skill annotate-hodor

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill streamlines the process of adding and accessing sidecar notes for Compass vault files, ensuring that team knowledge is easily accessible and compounded across sessions.

Core Features & Use Cases

  • Persistent Sidecar Notes: Attach notes to files that auto-surface when accessed, maintaining knowledge continuity.
  • JSON Format: Annotations are stored in JSON files for consistency and easy integration with other systems.
  • Use Case: When reviewing a spec, you can quickly add a note highlighting a potential issue and have it surface during the next session or review.

Quick Start

Annotate a spec with "Consider revisiting the security implications of this feature."

Frequently Asked Questions about annotate

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I add sidecar annotations to Compass vault files for project knowledge management?

Sidecar annotations are added to Compass vault files by attaching notes that automatically surface when the file is accessed, ensuring team knowledge is maintained and compounded across project sessions.

What is the file format used for storing document annotations in project workflows?

Document annotations are stored in JSON format, providing consistency for sidecar notes and enabling easy integration with other systems involved in project documentation workflows.

Can I use sidecar notes to maintain knowledge continuity across different review sessions?

Sidecar notes maintain knowledge continuity by auto-surfacing previously added annotations when the Compass vault file is accessed during subsequent review sessions or project reviews.

Does annotating Compass vault files require specific technical capabilities?

Annotating Compass vault files requires file access permissions and JSON parsing capabilities to successfully store and retrieve sidecar annotations for collaborative knowledge management.

What's the best way to highlight potential issues when reviewing a project spec?

Highlighting potential issues during a spec review is done by adding a sidecar note to the file, such as flagging security implications, which then auto-surfaces in the next session.

Are there limitations when using JSON sidecar files for collaborative project documentation?

JSON sidecar files require JSON parsing capabilities for retrieval and depend on direct file access, meaning integration limitations may arise if external systems lack JSON parsing support.