playbooks

home / skills / soapbox-pub / nostr-skills / nostr

nostr skill

/skills/nostr

This skill helps you explore up-to-date Nostr NIPs, discover capabilities, and implement correct nostr functionality across clients.

npx playbooks add skill soapbox-pub/nostr-skills --skill nostr

Review the files below or copy the command above to add this skill to your agents.

Files (1)
SKILL.md
1.8 KB
---
name: nostr
description: Knowledge about the Nostr protocol. Use to view up-to-date NIPs, discover capabilities of the Nostr protocol, and to implement Nostr functionality correctly.
license: CC-BY-SA-4.0
---

# Nostr Protocol

Nostr is a simple, open protocol that enables truly censorship-resistant and global social networks using cryptographic keys and signatures.

## Finding Nostr Documentation

All Nostr protocol documentation is maintained in the NIPs (Nostr Implementation Possibilities) repository. To access this information:

### Reading Individual NIPs

Individual NIPs can be fetched from:
```
https://github.com/nostr-protocol/nips/blob/master/{NIP}.md
```

For example, NIP-01 (the basic protocol specification) is available at:
```
https://github.com/nostr-protocol/nips/blob/master/01.md
```

### Finding Event Kinds

Documentation for Nostr event kinds is spread across one or more NIPs. **There is no direct relationship between the NIP number and the kind number.**

To find which NIPs document a specific event kind:

1. First, fetch the README:
   ```
   https://github.com/nostr-protocol/nips/blob/master/README.md
   ```

2. Reference the "Event Kinds" table in the README to find which NIP(s) document the kind you're looking for

### Discovering Existing Capabilities

The README should be consulted to:

- **View the list of NIPs** - Use this to discover what capabilities already exist on the Nostr network
- **Review client and relay messages** - Understand the communication protocol
- **Check the list of tags** - See what standardized tags are available
- **Decide on using existing NIPs** - Before implementing a feature, check if an existing NIP already covers it

### Best Practices

Always start by fetching and reviewing the README to understand the current state of the protocol and avoid reinventing existing functionality.

Overview

This skill provides up-to-date knowledge of the Nostr protocol, its NIPs (Nostr Implementation Possibilities), and how to implement Nostr features correctly. Use it to discover documented event kinds, standard tags, client/relay messaging, and to avoid duplicating existing protocol work. It helps you locate authoritative NIP sources and interpret the protocol landscape for design and implementation decisions.

How this skill works

It inspects the NIPs repository and the NIPs README to surface current protocol specifications, event kind mappings, and recommended tags and messages. The skill maps which NIPs document specific features and points you to the canonical NIP documents for deeper reading. It highlights existing capabilities so you can decide whether to adopt, extend, or propose new NIPs.

When to use it

  • Designing or implementing a Nostr client, relay, or extension and needing authoritative protocol references.
  • Looking up which NIP(s) document a particular event kind or tag.
  • Validating implementation choices against existing NIPs to avoid duplication.
  • Preparing a proposal or draft NIP and checking prior art and conventions.
  • Troubleshooting interoperability issues between clients and relays.

Best practices

  • Always start with the NIPs README to understand the current protocol state and event-kind mappings.
  • Cross-reference any feature with existing NIPs before designing custom behaviors.
  • Follow the canonical NIP documents for message formats, tags, and signature rules.
  • Document any protocol extensions clearly and consider proposing a NIP if broadly useful.
  • Test implementations against multiple relays and clients to ensure interoperability.

Example use cases

  • Find which NIP(s) define a specific event kind before implementing an event handler.
  • Discover standardized tags to annotate events correctly for client compatibility.
  • Locate the NIP that describes client-to-relay subscription and response formats.
  • Check the latest NIP text to implement signature verification and event creation rules.
  • Assess whether a proposed feature already exists or needs a new NIP proposal.

FAQ

Where are Nostr protocol documents hosted?

Canonical NIP documents are maintained in the NIPs repository; the README provides an index and event-kind table.

How do I find which NIP covers an event kind?

First open the NIPs README, then use the Event Kinds table to map the kind number to one or more NIPs that document it.