nlweb-setup

Installation
SKILL.md

NLWeb Setup

Config layout changed upstream. NLWeb replaced the single site_types.xml with two files in config/: sites.xml (site name → itemType list + description) and tools.xml (per-site / per-type tool definitions, prompts and examples, scoped by <Site id="…"> / <Item> blocks). Older guidance — including any site_type / extends inheritance syntax — describes the retired file. Fetch config/sites.xml and config/tools.xml from the live repo before editing anything.

Before writing code

Fetch live docs first:

  1. Fetch https://github.com/nlweb-ai/NLWeb (README) for the current minimum Python version and required deps.
  2. Fetch https://github.com/nlweb-ai/NLWeb/blob/main/docs/nlweb-hello-world.md for the canonical hello-world flow.
  3. Fetch https://github.com/nlweb-ai/NLWeb/blob/main/docs/nlweb-cli.md for current nlweb CLI flags.
  4. Web-search site:github.com/nlweb-ai/NLWeb docs/release_notes and read the most recent dated release note — config keys and required env vars change between releases.
  5. Identify the default write_endpoint and verify which backends are enabled by default in config/config_retrieval.yaml on main.

Conceptual Architecture

Installs
7
GitHub Stars
39
First Seen
May 21, 2026