Skip to content

Agent & AI Documentation

Use these resources to feed nostr-core documentation into your AI agent, LLM, or coding assistant.

Agent Integration

Ready-made files for AI agents to discover, understand, and integrate with nostr-core:

FileDescription
/llms.txtDiscovery index - structured overview of all docs, following the llms.txt standard
AGENT_README.mdFull integration guide - every method with request/response examples, error handling, agent tips
integration-prompt.mdCopy-paste system prompt and code templates for wiring agents to nostr-core

Quick Copy

Copy the full documentation as a single markdown file to paste into your LLM context:

Open llms-full.txt

Machine-Readable Index

The llms.txt file provides a structured index of all documentation pages:

Open llms.txt

What's Included

FileSizeDescription
/llms.txt~1 KBStructured index with page descriptions - point your agent here first
/llms-full.txt~25 KBComplete documentation in a single file - all guides + full API reference
AGENT_README.md~8 KBAgent integration guide with examples and error tables
integration-prompt.md~6 KBSystem prompt, code templates, MCP config, validation checklist

Usage with AI Tools

Claude / ChatGPT / Cursor / Copilot

  1. Open /llms-full.txt
  2. Select all and copy (Ctrl+A, Ctrl+C)
  3. Paste into your AI chat or attach as context

Agents & Automated Tools

Point your agent to fetch:

https://your-docs-site.com/llms.txt

The llms.txt file links to all documentation pages so agents can fetch only what they need.

Claude Code / Aider / Other CLI Tools

sh
curl -s https://your-docs-site.com/llms-full.txt | pbcopy
# Full docs are now in your clipboard

Signer Abstraction (NIP-07 & NIP-46)

nostr-core provides a unified Signer interface for delegating event signing to different backends:

SignerDescription
createSecretKeySigner(sk)Sign with a raw secret key
Nip07SignerDelegate to a browser extension (window.nostr)
NostrConnectRemote signing via NIP-46 (nostrconnect:// URI)

All three implement the same Signer interface (getPublicKey(), signEvent(), optional nip04, optional getRelays()), making them interchangeable in application code.

See the API docs for Signer, NIP-07, and NIP-46.

eCash Wallets (NIP-60)

nostr-core supports Cashu eCash wallets stored on Nostr:

ModuleDescription
nip60Cashu wallet management - wallet metadata, token proof storage, spending history, quote tracking

All wallet data is NIP-44 encrypted to self. See the API docs for NIP-60.

BOLT-11 Invoice Decoding

Decode Lightning invoices to extract amount, payment hash, description, expiry, route hints, and payee node key:

ModuleDescription
bolt11BOLT-11 decoder - supports mainnet/testnet/signet/regtest, uppercase QR codes, lightning: URIs

See the API docs for BOLT-11.

Blossom Media (NIP-B7)

Upload, download, and manage media on content-addressable Blossom servers:

ModuleDescription
blossomFull Blossom client - server lists (BUD-03), auth tokens (BUD-11), upload/download/delete/list/mirror

See the API docs for Blossom.

RSS / Atom / JSON Feed Import

Import articles from any blog feed and convert them into signed NIP-23 long-form events. Composes with Blossom for automatic image rehosting.

ModuleDescription
rssRSS 2.0 / Atom / JSON Feed parser, HTML → Markdown, deterministic d-tag, Blossom image mirror, end-to-end importFeedAsDrafts

Works with Blogger, WordPress, Substack, Ghost, Medium, Tumblr, and any feed that exposes RSS 2.0, Atom, or JSON Feed. See the API docs for RSS Import.

Private Messaging (NIP-59 & NIP-17)

nostr-core supports multi-layer encrypted messaging:

ModuleDescription
nip59Gift Wrap - wraps events in 3 encryption layers (rumor → seal → gift wrap) to hide sender identity
nip17Private DMs - end-to-end encrypted direct messages with sender anonymity, built on NIP-59

See the API docs for NIP-59 and NIP-17.

Claude Code Plugin

nostr-core is also available as a Claude Code plugin with 10 agent skills for building Lightning-enabled applications:

SkillCommandDescription
Navigate Nostr/navigate-nostrFind the right NIPs, LNURL LUDs, Cashu NUTs, Blossom BUDs, and map them to nostr-core modules
Nostr Identity/nostr-identityGenerate keypairs, derive from mnemonic, verify NIP-05, set up signers (NIP-07, NIP-46)
Nostr Messaging/nostr-messagingPrivate DMs (NIP-17), public notes, channels (NIP-28), groups (NIP-29), subscriptions
Nostr Social/nostr-socialThreads, reactions, reposts, articles, follows, badges, calendar, zaps, moderation
Lightning Agent/lightning-agentCopy-paste agent class with wallet, messaging, identity, and payments
LNbits MCP/lnbits-mcpConnect to LNbits via NWC + MCP Server for conversational wallet control
NWC Integration/nwc-integrateSet up nostr-core and connect to any NWC wallet
Lightning Payments/lightning-payPay invoices, Lightning Addresses, fiat, and keysend
Wallet Monitor/wallet-monitorReal-time notifications, transaction history, analytics
Nostr Primitives/nostr-primitivesLow-level keys, events, relays, encryption, encoding

Install the plugin

/plugin install nostr-core-org/nostr-core

See the Skills documentation for full details and usage examples.

Released under the MIT License.