bookmarks-api/README.md

Bookmarks API for Scripting and AI

An API add-on for Firefox to allow agentic and script-based management of user bookmarks.

The published product is the add-on in extension/. Issue a secret in Manage clients, store it with your secrets, and keep Firefox open. A separately installed native host is what accepts those local calls. The options page does not need the host.

This is not a bookmark sync engine, and it is not a Mozilla product.

Setup

1. Load the add-on (temporary via about:debugging, or a signed .xpi — docs/signing.md).
2. Toolbar → Manage clients → generate a secret → store it with your secrets.
3. To let scripts call in, register the native host once (tools/install-native-host.ps1 on this workstation).

Authenticated calls use Authorization: Bearer <secret> on http://127.0.0.1:17634. Method list for people working in this repo: AGENTS.md.

Security

• Binds 127.0.0.1 only. Browser Origin headers are rejected.
• Client hashes live in the add-on’s storage. The host asks the add-on whether a token is valid.
• Only bookmarks.* (plus meta.*). No history, cookies, tabs, or onMessageExternal.

License

MIT.