YaCy peer-to-peer search

io.github.pad01gPublished by GitHub account pad01gv1.0.0Updated Oct 24, 2026

Web search, crawling and ranking evaluation on your own YaCy peer: no API key, no central service.

Overview

AI-generated overview

Connects an assistant to your own YaCy peer for web search, crawling, ranking settings and search-quality evaluation, with no search API key.

What you can do
  • Search the peer's index and optionally the peer-to-peer network, with a configurable wait for answers
  • Start, pause, resume and stop crawls of a site, and list crawls with their handles
  • Inspect index status, connected peers and trust delegations
  • Read and change ranking and filtering settings, then evaluate ranking quality with precision, recall and R-precision
  • Remove a single page from the peer's own index
When to use it
Useful when you run your own YaCy peer and want an assistant to search it, crawl sites into it, tune ranking settings and measure search quality, without relying on a commercial search API.
Requirements
A running YaCy peer reachable over HTTP, given by YACY_URL. The server runs as a local stdio process, typically a Docker container on the same network as the peer, or Node 24 when run from source. Admin actions need YACY_ADMIN_USER and YACY_ADMIN_PASSWORD; optional YACY_CRAWL_ALLOW_PRIVATE, YACY_ALLOW_TRUST_SETTINGS and YACY_TIMEOUT_MS.
Before you install
YACY_ADMIN_PASSWORD is a secret passed as an environment variable and grants crawl, settings and delete rights. Crawling, crawl control, document deletion and ranking changes are marked destructive and alter the peer's index or configuration. YACY_CRAWL_ALLOW_PRIVATE=1 lets crawls reach loopback and private addresses. Titles and snippets come from page authors and other peers and should be treated as data, not instructions.

Installation

In SourceWeft

  1. Open YaCy peer-to-peer search in the dashboard and add it to a workspace.
  2. Enable the server for the chats that should use its tools.

Desktop only via STDIO. STDIO servers start a local process, so they need the SourceWeft desktop host.

Other MCP clients

Follow the launch instructions in the repository.

README

yacy-search MCP server

An MCP server for one YaCy peer: web search without a search API or API key, crawling, ranking settings and search quality evaluation. It runs next to the agent (stdio) and talks to the agent's own peer over HTTP. There is no central service: the peer is yours, and it searches the peer-to-peer network it belongs to. Registry name: io.github.pad01g/yacy-search.

It is written for the improved-search fork (results carry author signature verdicts and tags). Search, crawl, status and settings also work with upstream YaCy.

Run

Start a peer and the MCP server on one Docker network:

sh
docker network create yacy 2>/dev/null || truedocker run -d --name yacy --network yacy -p 127.0.0.1:8090:8090 \  -v yacy_data:/opt/yacy_search_server/DATA ghcr.io/pad01g/yacy-improved-search:latest
# Claude Codeclaude mcp add yacy -- docker run -i --rm --network yacy \  -e YACY_URL=http://yacy:8090 -e YACY_ADMIN_PASSWORD='<your password>' ghcr.io/pad01g/yacy-search-mcp:1.0.0

The fork's image starts with the administrator account admin / yacy: change the password at http://127.0.0.1:8090/ConfigAccounts_p.html before connecting the MCP server, and pass the new one.

Other clients (mcp.json style):

json
{  "mcpServers": {    "yacy": {      "command": "docker",      "args": ["run", "-i", "--rm", "--network", "yacy", "-e", "YACY_URL=http://yacy:8090", "-e", "YACY_ADMIN_PASSWORD=<your password>", "ghcr.io/pad01g/yacy-search-mcp:1.0.0"]    }  }}

For a peer outside Docker use -e YACY_URL=http://host.docker.internal:8090 (Linux: add --add-host=host.docker.internal:host-gateway). Without Docker: npm ci && node src/server.ts in this directory (Node 24).

VariableDefaultMeaning
YACY_URLhttp://localhost:8090base URL of the peer
YACY_ADMIN_USERadminadministrator account (crawl, status counts, settings)
YACY_ADMIN_PASSWORDunsetadministrator password; without it crawl_site, control_crawl, delete_document and set_ranking_setting are refused (even if the peer accepts local requests without a password), and the reading admin tools work only where the peer allows them without one
YACY_CRAWL_ALLOW_PRIVATEunset1: crawl_site may reach loopback and private addresses (an intranet). Otherwise only http(s) URLs of public hosts. This checks the start URL only; the links and redirects YaCy follows are limited by YaCy's own network.unit.domain (global on public peers refuses local addresses)
YACY_TIMEOUT_MS30000timeout of one request to the peer
YACY_ALLOW_TRUST_SETTINGSunset1: set_ranking_setting may also change trust.search.acceptUnverified and trust.policy.excludeTags

On the improved-search fork, the vector search (short questions find pages without the exact words) is used only for searches of the peer's administrator or from its host. When the MCP server runs in another container, set search.vector.public=true on the peer (it then embeds every new query of its search page).

Tools

ToolWhat it does
search_webfull-text search; resource: "global" also asks connected peers and waits waitMs before ranking all answers
crawl_sitestart a crawl (url, depth, range: domain / subpath / wide, maxPages per host, default 200)
get_index_statusindexed documents, crawl queues, peer type and connections; explains a paused crawler (load average) and a peer without a public address
list_peersconnected peers: signed seed, reach (direct / relay), tags
get_ranking_settingsthe ranking and filtering settings with their meaning
set_ranking_settingchange one of them (allow-list only: minimum match, coverage and thin page weights, title phrase boost, wait time; unverified results and excluded tags only with YACY_ALLOW_TRUST_SETTINGS=1)
evaluate_rankingqueries with known relevant URLs: precision@k, recall@k, R-precision, the rank of each relevant URL; finishes within about 50 s (queries that do not fit are reported as skipped)
get_trust_statusthe signed delegations and peer lists the peer holds
list_crawlsthe crawls started on the peer, with the handle control_crawl needs
control_crawlpause or resume the local crawler, or stop one crawl (indexed pages stay)
delete_documentremove one page from the peer's own index (stop a running crawl of that site first)

1.0.0 renamed the tools to a consistent verb_noun form (no aliases): search → search_web, crawl → crawl_site, crawls → list_crawls, crawl_control → control_crawl, index_status → get_index_status, peers → list_peers, trust_status → get_trust_status. Clients that call tools by name need the new names.

A typical loop for improving results: evaluate_ranking → set_ranking_setting → evaluate_ranking.

Titles and snippets come from page authors and other peers: the tool descriptions tell the model to treat them as data, not instructions. crawl_site, control_crawl, delete_document and set_ranking_setting are marked destructive so that clients ask before calling them. Values of settings are checked per key, and a value YaCy stores differently is rolled back.

Test

sh
npm ci && npm run typecheck && npm test                      # unit testsYACY_URL=http://localhost:8090 YACY_ADMIN_PASSWORD=yacy npm test   # also calls every tool on a live peer

License

This directory (the MCP server) is under the MIT license. It talks to YaCy only over HTTP and contains no YaCy code; the rest of this repository, YaCy itself, stays under the GPL.

Source: mcp/README.md at commit 2fa4cc2

Tools

0
SourceWeft has not started this package in its sandbox yet, so its tools are not known.

Version history

5
  1. v1.0.0LatestOct 1, 2026
  2. v0.3.0Oct 1, 2026
  3. v0.2.1Sep 30, 2026
  4. v0.2.0Sep 29, 2026
  5. v0.1.0Sep 28, 2026

Score

50% of the applicable checks met

How complete this listing is, computed from the registry entry, the endpoint and public sources. Not a rating of the server and not a statement that it is safe or working today: reachability is a dated check, and no installs or reviews go into the score.

  • Reached in the last 30 days25 pts

    Keep the endpoint answering the MCP handshake; SourceWeft probes it every 30 days.

  • Auth declared10 pts

    Declare the credential headers in the registry entry, or keep the endpoint answering the probe so its auth can be classified.

  • Tools listed15 pts

    Answer tools/list without a credential, or ship a package that starts in a sandbox without one.

  • DescriptionRequired15 pts
  • Logo10 pts
  • Documentation15 pts
  • License10 pts