Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions docs/user/recipes/foam-notes-agent-skill.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Foam Notes Agent Skill

This #recipe describes how to use [foam-notes](https://github.com/Hegghammer/foam-notes), an [AgentSkills](https://agentskills.io/specification)-compatible skill that lets AI coding assistants work with your Foam notes.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you please put a warning here about prompt injection and the security implications of using 3rd party skills?
Users should review the skill files/scripts before adopting them


## Supported Assistants

- [Claude Code](https://claude.com/product/claude-code)
- [Codex](https://openai.com/codex/)
- [OpenCode](https://opencode.ai)
- Any other assistant that supports the AgentSkills format

## Features

- Create, edit, delete, and rename notes
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's too bad that you can't leverage any of the Foam code for those python scripts. Basically you are replicating some of Foam's features, whereas if you were to use foam-core that wouldn't be necessary. We don't currently publish foam-core as a standalone library, so I see why you did that.
I would put a note about that though here.

- Intelligent wikilink and tag suggestions
- Backlinks discovery
- Daily notes and templates
- Graph visualization
- Full Foam documentation included for easy querying

## Installation

Clone the skill repository into your assistant's skill folder:

```bash
git clone https://github.com/Hegghammer/foam-notes.git
```

The location of the skill folder depends on your assistant:

- **Claude Code**: `.claude/skills/`
- **OpenCode**: `.opencode/skills/`
- **Codex**: `.codex/skills/`

Refer to your assistant's documentation for details.

## Usage

Once installed, the skill is automatically available to your assistant. You can ask it to create new notes, edit existing ones, suggest wikilinks and tags, find backlinks, and more. If you find that the skill doesn't do quite what you want, just have the agent modify the skill for you.
1 change: 1 addition & 0 deletions docs/user/recipes/recipes.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,7 @@ A #recipe is a guide, tip or strategy for getting the most out of your Foam work

- Capture notes from Drafts app on iOS [[capture-notes-with-drafts-pro]]
- Capture notes from iOS Shortcuts [[capture-notes-with-shortcuts-and-github-actions]]
- Use AI coding assistants with your Foam notes [[foam-notes-agent-skill]]

## Creative ideas

Expand Down
Loading