How do I install YaCy Peer To Peer Search?

Copy the stdio config for Cursor, Claude Desktop, Claude Code, or VS Code on this page. It uses the publisher's install, not a PlugMCP proxy.

Does YaCy Peer To Peer Search need an API key?

The publisher lists these environment variables: YACY_URL, YACY_ADMIN_USER, YACY_ADMIN_PASSWORD, YACY_CRAWL_ALLOW_PRIVATE, YACY_ALLOW_TRUST_SETTINGS.

What transport does YaCy Peer To Peer Search use?

YaCy Peer To Peer Search runs locally over stdio.

When was YaCy Peer To Peer Search last checked?

Last checked 2026-11-10. Web search, crawling and ranking evaluation on your own YaCy peer: no API key, no central service.

YaCy Peer To Peer Search MCP server

Power your agent

Add this server

The publisher's own command. Not a PlugMCP endpoint.

Add to Cursor Add to VS Code Run on PlugMCP

Host a copy with our keys and logs.

Local command

docker run -i --rm ghcr.io/pad01g/yacy-search-mcp:1.0.0

Credentials from the publisher

YACY_URL — Base URL of your YaCy peer as seen from the MCP server container, e.g. http://yacy:8090 on a shared Docker network (docker run --network ...), or http://host.docker.internal:8090
YACY_ADMIN_USER — YaCy administrator account, needed for crawling and settings
YACY_ADMIN_PASSWORD — YaCy administrator password; without it crawl, settings and the index counts of index_status are not available
YACY_CRAWL_ALLOW_PRIVATE — 1 lets crawl reach loopback and private addresses (intranets); off by default
YACY_ALLOW_TRUST_SETTINGS — 1 lets set_ranking_setting change the trust filter settings (acceptUnverified, excludeTags); off by default

Claude Code has no install link for a local command. Copy the command below and run it in a terminal.

shClaude Code

1YACY_URL=<value> YACY_ADMIN_USER=<value> YACY_ADMIN_PASSWORD=<secret> YACY_CRAWL_ALLOW_PRIVATE=<value> YACY_ALLOW_TRUST_SETTINGS=<value> claude mcp add io.github.pad01g-yacy-search -- docker run -i --rm ghcr.io/pad01g/yacy-search-mcp:1.0.0

Run in a terminal.

jsonClaude Desktop

1{2  "mcpServers": {3    "io.github.pad01g-yacy-search": {4      "command": "docker",5      "args": [6        "run",7        "-i",8        "--rm",9        "ghcr.io/pad01g/yacy-search-mcp:1.0.0"10      ],11      "env": {12        "YACY_URL": "<value>",13        "YACY_ADMIN_USER": "<value>",14        "YACY_ADMIN_PASSWORD": "<secret>",15        "YACY_CRAWL_ALLOW_PRIVATE": "<value>",16        "YACY_ALLOW_TRUST_SETTINGS": "<value>"17      }18    }19  }20}

claude_desktop_config.json

Local · ociPublisher installStep-by-step: add this in Claude

Remote URL or a command on your machine? How the two installs differ

Run on PlugMCP

Host a copy with our keys and logs.

A new server you create. It is not this listing's official endpoint. Use the publisher install when you want their URL and their credentials.

Launch

Server facts

Local

Transport: stdio
Version

Tools

No tool list yet. Remote servers get one after the first health check.

FAQ

Questions

A peer-to-peer web search engine you run yourself, usable by AI agents without a search API or API key. This fork of YaCy adds stricter ranking, Chinese/Japanese/Korean search, author signatures on every document, coordinator-signed trust lists and NAT traversal through a libp2p relay. Agents: MCP server (io.github.pad01g/yacy-search), skill, llms.txt. Run it: docker run -d -p 127.0.0.1:8090:8090 -v yacy_data:/opt/yacy_search_server/DATA ghcr.io/pad01g/yacy-improved-search:latest (keep the volume: it holds the peer key; change the default password yacy first). See the project page, FORK.md and the experiments in pad01g/yacy-lab. It does not interoperate with the public YaCy network by default.

Join without asking anyone: run a peer with -e YACY_P2P_BOOTSTRAP_PEERS=http://<any member>:8090 (works across Tailscale too), publish your own pages and services, list your peer in pad01g/yacy-trust or run your own coordinator (a key and a signed file, no server). How to join — 日本語 · 简体中文 · Español · Português · 한국어 · Deutsch · Français. Pull requests are welcome (branch improved-search): code, measurements, translations.

Search Engine Software

Web Search Crawl Start Index Browser

What is YaCy?

YaCy is a full search engine application containing a server hosting a search index, a web application to provide a nice user front-end for searches and index creation and a production-ready web crawler with a scheduler to keep a search index fresh.

YaCy search portals can also be placed in an intranet environment, making it a replacement for commercial enterprise search solutions. A network scanner makes it easy to discover all available HTTP, FTP and SMB servers.

Running a personal Search Engine is a great tool for privacy; indeed YaCy was created with the privacy aspect as priority motivation for the project.

You can also use YaCy with a customized search page in your own web applications.

Large-Scale Web Search with a Peer-to-Peer Network

Each YaCy peer can be part of a large search network where search indexes can be exchanged with other YaCy installation over a built-in peer-to-peer network protocol.

This is the default operation that enables new users to instantly access a large-scale search cluster, operated only by YaCy users.

You can opt-out from the YaCy cluster operation by choosing a different operation mode in the web interface. You can also opt-out from the network in individual searches, turning the use of YaCy a completely privacy-aware tool - in this operation mode search results are computed from the local index only.

Installation

We recommend to compile YaCy yourself and install it from the git sources. Pre-compiled YaCy packages exist but are not generated on a regular basis. Automaticaly built latest developer release is available at release.yacy.net. To get a ready-to-run production package, run YaCy from Docker.

Compile and run YaCy from git sources

You need Java 17 or later to run YaCy and ant to build YaCy. This would install the requirements on debian:

sudo apt-get install openjdk-17-jdk-headless ant

Then clone the repository and build the application:

git clone --depth 1 https://github.com/yacy/yacy_search_server.git
cd yacy_search_server
ant clean all

To start YaCy, run

./startYACY.sh

The administration interface is then available in your web browser at http://localhost:8090. Some of the web pages are protected and need an administration account; these pages are usually also available without a password from the localhost, but remote access needs a log-in. The default admin account name is admin and the default password is yacy. Please change it after installation using the http://<server-address>:8090/ConfigAccounts_p.html service.

Stop YaCy on the console with

./stopYACY.sh

Build the Windows installer

Windows installers are built with NSIS and require the release payload produced by Ant. Install NSIS (makensis) and then run:

ant distWinInstaller

This runs the full build, stages files into RELEASE/MAIN, and produces the installer in RELEASE/ as yacy_v<version>_*.exe.

If you want it in two steps, you can run:

ant copyMain4Dist
makensis RELEASE/WINDOWS/build.nsi

Run YaCy using Docker

The Official YaCy Image is yacy/yacy_search_server:latest. It is hosted on Dockerhub at https://hub.docker.com/r/yacy/yacy_search_server

To install YaCy in intel-based environments, run:

docker run -d --name yacy_search_server -p 8090:8090 -p 8443:8443 -v yacy_search_server_data:/opt/yacy_search_server/DATA --restart unless-stopped --log-opt max-size=200m --log-opt max-file=2 yacy/yacy_search_server:latest

then open http://localhost:8090 in your web-browser.

For building Docker image from latest sources, see docker/Readme.md.

Help develop YaCy

clone https://github.com/yacy/yacy_search_server.git using build-in Eclipse features (File -> Import -> Git)
or download source from this site (download button "Code" -> download as Zip -> and unpack)
Open Help -> Install New Software -> add.. -> add archived IvyDE Updatesite "https://archive.apache.org/dist/ant/ivyde/updatesite/" -> Install "Apache IvyDE"
right-click on the YaCy project in the package explorer -> Ivy -> resolve

This will build YaCy in Eclipse. To run YaCy:

Package Explorer -> YaCy: navigate to source -> net.yacy
right-click on yacy.java -> Run as -> Java Application

Join our development community, got to https://community.searchlab.eu

Send pull requests to https://github.com/yacy/yacy_search_server

APIs and attaching software

YaCy has many built-in interfaces, and they are all based on HTTP/XML and HTTP/JSON. You can discover these interfaces if you notice the orange "API" icon in the upper right corner of some web pages in the YaCy web interface. Click it, and you will see the XML/JSON version of the respective webpage. You can also use the shell script provided in the /bin subdirectory. The shell scripts also call the YaCy web interface. By cloning some of those scripts you can easily create more shell API access methods.

License

This project is available as open source under the terms of the GPL 2.0 or later. However, some elements are being licensed under GNU Lesser General Public License. For accurate information, please check individual files. As well as for accurate information regarding copyrights. The (GPLv2+) source code used to build YaCy is distributed with the package (in /source and /htroot).

Contact

Visit the international YaCy forum where you can start a discussion there in your own language.

Questions and requests for paid customization and integration into enterprise solutions. can be sent to the maintainer, Michael Christen per e-mail (at [email protected]) with a meaningful subject including the word 'YaCy' to prevent it getting stuck in the spam filter.

Michael Peter Christen

Add this server

Host a copy with our keys and logs.

Server facts

Tools

Questions

How do I install YaCy Peer To Peer Search?

Does YaCy Peer To Peer Search need an API key?

What transport does YaCy Peer To Peer Search use?

When was YaCy Peer To Peer Search last checked?

Documentation

What is YaCy?

Large-Scale Web Search with a Peer-to-Peer Network

Installation

Compile and run YaCy from git sources

Build the Windows installer

Run YaCy using Docker

Help develop YaCy

APIs and attaching software

License

Contact