Agent skill

Obsidian Project Documentation

by jeremylongshore in jeremylongshore/tons-of-skills-marketplace

Document technical projects in Obsidian vault. An agent skill from jeremylongshore/tons-of-skills-marketplace.

MITAuto-check: notesKnowledge Management

Install Obsidian Project Documentation

skills CLI
$ npx skills add jeremylongshore/tons-of-skills-marketplace --skill obsidian-project-documentation -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install jeremylongshore/tons-of-skills-marketplace obsidian-project-documentation --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/jeremylongshore/tons-of-skills-marketplace.git skills-src && mkdir -p .claude/skills && cp -r skills-src/plugins/productivity/obsidian-project-documentation/skills/obsidian-project-documentation .claude/skills/obsidian-project-documentation && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
obsidian-project-documentation
GitHub stars
2.8k
Token cost
~2k tokens
SKILL.md length
758 words
Files
4
Skills in repo
3,342
Repo updated
First seen
Licence
MIT

At a glance

Document technical projects in Obsidian vault. An agent skill from jeremylongshore/tons-of-skills-marketplace.

  • Works in 3 steps: From the User's message - If the User… → From git repository → From directory name
  • The User mentions document this
  • SKILL.md covers How This Works, Shared Step: Load Configuration, Path A: Session Start… and Path B: Documentation Run…, plus 2 more sections
  • Calls git

What it does

Obsidian Project Documentation is an agent skill from jeremylongshore/tons-of-skills-marketplace. Document technical projects in Obsidian vault. Use when the User mentions "document this", "close out", "wrap up", "update notes", "track progress", "where are we at", or asks about project docs.

Its SKILL.md is about 2k tokens, which your agent loads only when the skill is triggered. The skill folder holds 3 other files (for example `area-mapping.md`, `context-detection.md` and `project-template.md`).

It sits in Knowledge Management. It works with Obsidian. The repository describes itself as: Model-agnostic agent-skills platform with a harness-free canonical layer, verified adapters, and the ccpi package manager. Explore at tonsofskills.com. The licence is MIT.

When your agent uses it

  • The User mentions document this
  • Where are we at
  • Asks about project docs

Example prompts

  • “document this”
  • “close out”
  • “wrap up”
  • “/obsidian-project-documentation”

Requirements

  • Pre-approved tools (allowed-tools): Read, Bash, AskUserQuestion, Task

Workflow steps

3 steps, taken from the first numbered list in SKILL.md.

  1. From the User's message - If the User explicitly mentions project name in their request
  2. From git repository
  3. From directory name

What it can do on your machine

Read from SKILL.md and the folder at commit cfae287. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves these tools, so the agent can use them without asking each time:

    • Read
    • Bash
    • AskUserQuestion
    • Task

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Shell commands in SKILL.md call:

    • git

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md. Its commands use git, which can reach the network depending on how they are called.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Obsidian Project Documentation loads about 2k tokens when it runs. Until then it costs about 57 tokens; SKILL.md has 758 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~57
When it runs · the whole SKILL.md, loaded when a task matches
~2k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check: notes

The automated check noted patterns worth knowing about, such as sudo or a known installer.

  • NotePre-approves every shell command (allowed-tools: Bash)SKILL.md
    allowed-tools: Read, Bash, AskUserQuestion, Task

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from jeremylongshore/tons-of-skills-marketplace at commit cfae287, republished under its MIT licence (© jeremylongshore). 758 words, ~2,006 tokens.

Download SKILL.mdSave it as .claude/skills/obsidian-project-documentation/SKILL.md (or your agent's skills folder). This skill also uses 3 other files; get the full folder from GitHub.
name
obsidian-project-documentation
description
Document technical projects in Obsidian vault. Use when the User mentions "document this", "close out", "wrap up", "update notes", "track progress", "where are we at", or asks about project docs.
allowed-tools
Read, Bash, AskUserQuestion, Task
version
3.2.1

Obsidian Project Documentation Assistant

This skill helps maintain project documentation in an Obsidian vault while working with Claude Code. It automatically captures project progress and insights into structured, consistent notes.

Architecture: This skill acts as a lightweight launcher that detects project context, asks clarifying questions if needed, then launches an agent to handle the documentation work in the background.

How This Works

Three situations trigger this skill, falling into two execution paths:

SituationTriggerPath
1 — New session startUser opens a project and says hello, or Claude Code startsPath A — read-only context load
2 — Mid-session documentation"document this", "update notes", "track progress", etc.Path B — full documentation run
3 — Session end"wrap up", "close out", "we're done for today", etc.Path B — full documentation run

Path A is read-only. It must never launch the documentation agent or write to the vault.

Path B launches the agent. It performs context detection and spawns the manager agent to write vault notes.

Shared Step: Load Configuration

Before following either path, load the config:

Step 1: Load Configuration
bash
cat ~/.claude/obsidian-project-assistant-config.json 2>/dev/null

Expected format:

json
{
  "vault_path": "/path/to/ObsidianVault",
  "areas": ["Hardware", "Software", "Woodworking", "Music Synthesis"],
  "auto_commit": false,
  "auto_push": false,
  "git_enabled": true
}

If config doesn't exist (first-run setup):

Use AskUserQuestion to ask the User for their Obsidian vault path:

text
Question: "Where is your Obsidian vault? (e.g. ~/Documents/ObsidianVault)"
Options:
  - ~/Documents/ObsidianVault
  - ~/Documents/MyVault
  - Other (custom path)

Then write the config to ~/.claude/obsidian-project-assistant-config.json:

bash
cat > ~/.claude/obsidian-project-assistant-config.json <<EOF
{
  "vault_path": "<user-provided path with ~ expanded to $HOME>",
  "areas": ["Hardware", "Software", "Woodworking", "Music Synthesis"],
  "auto_commit": false,
  "auto_push": false,
  "git_enabled": true
}
EOF

Confirm the config was written, then follow the appropriate path below.

Path A: Session Start (Situation 1)

Read-only. Do not launch the agent. Do not write to the vault.

Step A1: Detect Project Name

Use the same detection logic as Step B2 (git repo name → directory name) to determine which vault note to load.

Step A2: Read Project Context
bash
cat "{vault_path}/Projects/{project_name}.md" 2>/dev/null

Also read CLAUDE.md from the current working directory if it exists.

Step A3: Welcome the User

Greet the User by name, summarise:

  • Current project phase and status from the vault note
  • The next steps recorded at the end of the last session
  • Any decisions or open questions worth flagging

Keep this brief — it is an orientation, not a report.

Path B: Documentation Run (Situations 2 & 3)

Step B1: Quick Context Detection
Detect Project Name

Try these methods in order:

  1. From the User's message - If the User explicitly mentions project name in their request

  2. From git repository:

    bash
    git rev-parse --is-inside-work-tree 2>/dev/null && basename $(git rev-parse --show-toplevel)

    Transform kebab-case → Title Case (e.g., "obsidian-project-assistant" → "Obsidian Project Assistant")

  3. From directory name:

    bash
    basename $(pwd)

If none of these work or result is generic (like "src", "build", "test"), refer to Step B2 below.

Detect Project Area

Run all four area detections in parallel and count matches. This avoids the false positives of a sequential if/elif chain where the first match wins regardless of signal strength.

bash
HW=$(find . -maxdepth 2 -type f \( -name "*.ino" -o -name "*.pcb" -o -name "*.sch" -o -name "platformio.ini" -o -name "arduino_secrets.h" \) 2>/dev/null | wc -l)
SW=$(find . -maxdepth 2 -type f \( -name "package.json" -o -name "requirements.txt" -o -name "Cargo.toml" -o -name "go.mod" -o -name "*.py" -o -name "*.js" -o -name "*.ts" \) 2>/dev/null | wc -l)
WW=$(find . -maxdepth 2 -type f \( -name "*.stl" -o -name "*.blend" -o -name "*.f3d" -o -name "*.skp" -o -name "cut-list.md" \) 2>/dev/null | wc -l)
MS=$(find . -maxdepth 2 -type f \( -name "*.pd" -o -name "*.maxpat" -o -name "*.syx" -o -name "*.amxd" -o -name "patch-notes.md" \) 2>/dev/null | wc -l)

Select the area using this decision logic:

  • If HW > 0 AND SW > 0: area is ambiguous (embedded software) — refer to Step B2
  • Else if exactly one count is greater than all others: use that area
  • Else if all counts are zero, or no clear winner: refer to Step B2

If no clear match, refer to Step B2 below.

Show full SKILL.md (279 more words)Show less
Extract Description

Try to extract a brief description:

  1. Check if README.md exists and read first paragraph
  2. Check package.json for description field
  3. Parse the User's message for description
  4. See Step B2 below if the previous steps fail.
Step B2: Ask Clarifying Questions

If project_name is null OR area is null, use AskUserQuestion before launching agent:

If project name is unclear:

text
Question: "What would you like to name this project?"
Options:
  - [Current directory name]
  - [Git repo name if available]
  - Other (custom input)

If area is unclear:

text
Question: "What type of project is this?"
Options:
  - Hardware
  - Software
  - Woodworking
  - Music Synthesis
  - Other (custom input)
Step B3: Launch Documentation Agent

Launch an obsidian-project-documentation:manager agent with a prompt that includes all of the following context variables. Every variable must be populated from the sources listed — do not leave any as empty or undefined.

VariableSource
{vault_path}vault_path from config
{project_name}Detected or user-supplied in Step 2–3
{area}Detected or user-supplied in Step 2–3
{description}Extracted or user-supplied in Step 2–3
{cwd}Run pwd
{current_date}Run date +%Y-%m-%d
{auto_commit}auto_commit from config
{auto_push}auto_push from config
{git_enabled}git_enabled from config
{user_original_message}The exact message the User sent that triggered this skill

Use this prompt template, substituting each {variable} with its value:

text
Vault Path: {vault_path}
Project Name: {project_name}
Project Area: {area}
Description: {description}
Working Directory: {cwd}
Current Date: {current_date}
auto_commit: {auto_commit}
auto_push: {auto_push}
git_enabled: {git_enabled}
User's original message: {user_original_message}
Step B4: Report Results

When the agent completes, inform the User:

text
✅ Project documented successfully!
📝 Updated: {path_to_note}
📋 Summary: {what_was_documented}
🔄 Git: {commit_status} {push_status}

Error Handling

If errors occur:

  • Config missing: Run first-run setup (ask for vault path, write config)
  • Vault not accessible: Verify vault_path in config
  • Git operations fail: Report error, but still create/update note
  • Template missing: Use a basic template or ask the User to reinstall

Important things to remember

  • Use absolute paths for all file operations.
  • Use the current date for all timestamp operations.
  • Handle errors gracefully (missing templates, git failures, etc.).
  • When refering to the User, use their name and not 'User'. If in any doubt of the User's pronouns, ask the User but always remember them.

© jeremylongshore, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 3 other files in plugins/productivity/obsidian-project-documentation/skills/obsidian-project-documentation of jeremylongshore/tons-of-skills-marketplace.

  • SKILL.md
  • area-mapping.md
  • context-detection.md
  • project-template.md

Open the folder on GitHubat commit cfae287

Compare with similar skills

Obsidian Project Documentation next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Obsidian Project Documentation compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Obsidian Project Documentation this skilljeremylongshore/tons-of-skills-marketplace2.8k—~2kAutomated safety check: NotesMIT
Auditpricklywiggles/niamos192—~1.4kAutomated safety check: PassNone
Brainpoteto/brainmaxxing325—~635Automated safety check: PassMIT
QueryHurricaHjz/second-yourself123—~2.2kAutomated safety check: PassMIT
AI BrainOotto-AI/claude-content-skills130—~1.1kAutomated safety check: PassMIT
Setupjdpolasky/ai-chief-of-staff105—~3.5kAutomated safety check: PassMIT

Similar skills

  • Audit

    pricklywiggles/niamos

    Scan this Obsidian vault for content that's drifted from the conventions in CLAUDE.md (status↔folder drift, missing required fields, naming violations, stale active items, frontmatter health issues…

    192 GitHub stars~1.4k tokensUpdated 3 mo ago
    Knowledge ManagementAuto-check passed
  • Brain

    poteto/brainmaxxing

    Read/write brain files (Obsidian vault at brain/). An agent skill from poteto/brainmaxxing.

    325 GitHub stars~635 tokensUpdated 7 mo ago
    Knowledge ManagementAuto-check passed
  • Query

    HurricaHjz/second-yourself

    Answer questions against the local Obsidian wiki — not from model memory.

    123 GitHub stars~2.2k tokensUpdated 9 days ago
    Knowledge ManagementAuto-check passed
  • AI Brain

    Ootto-AI/claude-content-skills

    Give Claude a permanent, searchable long-term memory using an Obsidian vault as the store.

    130 GitHub stars~1.1k tokensUpdated 3 days ago
    Knowledge ManagementAuto-check passed
  • Setup

    jdpolasky/ai-chief-of-staff

    First-time setup for the Chief of Staff system. An agent skill from jdpolasky/ai-chief-of-staff.

    105 GitHub stars~3.5k tokensUpdated 8 days ago
    Knowledge ManagementAuto-check passed
  • Obsidian Project Memory

    brycewang-stanford/Auto-Empirical-Research-Skills

    This skill should be used when the user asks to maintain an Obsidian knowledge base for a research project, import an existing research repository into Obsidian, keep project memory or daily notes…

    4.6k GitHub stars~2.4k tokensUpdated 5 days ago
    Knowledge ManagementAuto-check passed

More from jeremylongshore/tons-of-skills-marketplace

All 3,342 skills in this repo
  • Performing Security Code Review

    jeremylongshore/tons-of-skills-marketplace

    Execute this skill enables AI assistant to conduct a security-focused code review using the security-agent plugin.

    2.8k GitHub starsUsed in 2 repos~1.3k tokens
    Auto-check: notes
  • Adapting Transfer Learning Models

    jeremylongshore/tons-of-skills-marketplace

    Build this skill automates the adaptation of pre-trained machine learning models using transfer learning techniques.

    2.8k GitHub stars~1.1k tokensUpdated today
    Auto-check passed
  • Agent Context Loader

    jeremylongshore/tons-of-skills-marketplace

    Execute proactive auto-loading: automatically detects and loads agents.md files.

    2.8k GitHub stars~1.1k tokensUpdated today
    Auto-check passed
  • Aggregating Performance Metrics

    jeremylongshore/tons-of-skills-marketplace

    Aggregate and centralize performance metrics from applications, systems, databases, caches, and services.

    2.8k GitHub stars~1.2k tokensUpdated today
    Auto-check passed
  • Analyzing Capacity Planning

    jeremylongshore/tons-of-skills-marketplace

    Execute this skill enables AI assistant to analyze capacity requirements and plan for future growth.

    2.8k GitHub stars~947 tokensUpdated today
    Auto-check passed
  • Analyzing Database Indexes

    jeremylongshore/tons-of-skills-marketplace

    Process use when you need to work with database indexing. An agent skill from jeremylongshore/tons-of-skills-marketplace.

    2.8k GitHub stars~2k tokensUpdated today
    Auto-check passed

Works with

Questions about Obsidian Project Documentation

What does Obsidian Project Documentation do?

Document technical projects in Obsidian vault. An agent skill from jeremylongshore/tons-of-skills-marketplace. Obsidian Project Documentation is an agent skill from jeremylongshore/tons-of-skills-marketplace. Document technical projects in Obsidian vault.

When should I use Obsidian Project Documentation?

Obsidian Project Documentation fits situations like: the User mentions document this; where are we at; asks about project docs.

How do I install Obsidian Project Documentation in Claude Code?

Run `npx skills add jeremylongshore/tons-of-skills-marketplace --skill obsidian-project-documentation -a claude-code`. Or copy the skill folder (plugins/productivity/obsidian-project-documentation/skills/obsidian-project-documentation in jeremylongshore/tons-of-skills-marketplace) into .claude/skills/obsidian-project-documentation in your project. Claude Code loads it when a task matches its description.

How do I install Obsidian Project Documentation in Codex?

Run `npx skills add jeremylongshore/tons-of-skills-marketplace --skill obsidian-project-documentation -a codex`. Or copy the skill folder (plugins/productivity/obsidian-project-documentation/skills/obsidian-project-documentation in jeremylongshore/tons-of-skills-marketplace) into .agents/skills/obsidian-project-documentation in your project. Codex loads it when a task matches its description.

Can I use Obsidian Project Documentation in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add jeremylongshore/tons-of-skills-marketplace --skill obsidian-project-documentation -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/obsidian-project-documentation, .gemini/skills/obsidian-project-documentation, .github/skills/obsidian-project-documentation and .opencode/skills/obsidian-project-documentation in your project.

What does Obsidian Project Documentation need to run?

Going by SKILL.md and its folder, Obsidian Project Documentation needs the command-line tools its instructions call (git). Its frontmatter pre-approves these tools: Read, Bash, AskUserQuestion, Task.

Does Obsidian Project Documentation access the network?

SKILL.md contains no URLs. Its commands use git, which can reach the network depending on how they are called. This is read from the text; nothing was executed.

Is Obsidian Project Documentation safe to install?

Our automated static check of SKILL.md found notes only (pre-approves every shell command (allowed-tools: bash)), nothing it rates as a warning. It is not a guarantee. Review the folder before installing.

What licence does Obsidian Project Documentation use?

Obsidian Project Documentation is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Obsidian Project Documentation use?

About 2k tokens (SKILL.md is roughly 8k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Obsidian Project Documentation?

Skills that share tags, products or a category with Obsidian Project Documentation: Audit (pricklywiggles/niamos, 192 stars), Brain (poteto/brainmaxxing, 325 stars), Query (HurricaHjz/second-yourself, 123 stars) and AI Brain (Ootto-AI/claude-content-skills, 130 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Obsidian Project Documentation?

jeremylongshore (a GitHub user) maintains it in jeremylongshore/tons-of-skills-marketplace, which has 2,827 GitHub stars. The repository holds 3,342 skills in this directory. The repository was last updated on October 10, 2026.

Source: jeremylongshore/tons-of-skills-marketplace on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.