DESIGN.md@agent/searchA

DESIGN.md@agent/search from yaoapp/yao is a DESIGN.md file: the design rules coding agents follow in that repo.

Install it, pinned
mdr add yaoapp/yao/agent/search/DESIGN.md@git:20251215.00f9d86

Pins git:20251215.00f9d86 in mdr.lock. Pin the fingerprint instead.

Audit grade
A, 14 of 14 checks passed
Kind
DESIGN.md file
Repository
yaoapp/yao
Path
agent/search/DESIGN.md
Versions recorded
5
Latest version
git:20251215.00f9d86, committed Dec 15, 2025
First version recorded
Dec 13, 2025
Size
116,583 bytes
Repository stars
8,264
License
a license file GitHub does not identify

Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.

What the file says

# Search Module Design

## Overview

The Search module provides a unified RAG (Retrieval-Augmented Generation) interface for Yao Agent, supporting three search types:

| Type  | Source         | Use Case                                             |
| ----- | -------------- | ---------------------------------------------------- |
| `web` | Internet       | Real-time information, news, external knowledge      |
| `kb`  | Knowledge Base | Documents, FAQs, internal knowledge (vector + graph) |
| `db`  | Database       | Structured data from Yao Models (QueryDSL)           |

The module follows the **Handler + Registry** pattern consistent with the `content` module, and exposes JSAPI for flexible usage in Create/Next hooks.

## Key Features

- **Unified JSAPI**: `ctx.search.Web()`, `ctx.search.KB()`, `ctx.search.DB()`, `ctx.search.Parallel()`
- **Citation System**: Auto-generate citation IDs (`#ref:xxx`) for LLM reference
- **Real-time Output**: Stream search progress to client
- **Trace Integration**: Report search operations to user for transparency
- **Reranking**: Builtin, Agent, or MCP-based result reranking
- **Graceful Degradation**: Search errors don't block agent flow
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add yaoapp/yao/agent/search/DESIGN.md@sha256:807621590eacff0b

The line at the top of this page pins the label git:20251215.00f9d86, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.

Badge

mdr badge

[![mdr](https://markdownregistry.com/badge/art_sslhplqndcarmvni.svg)](https://markdownregistry.com/a/art_sslhplqndcarmvni)

5 badge image fetches in 30 days. What the badge shows.

Versions

The registry has recorded 5 versions of this file, between Dec 13, 2025 and Dec 15, 2025, more than one a day.

versioncommittedcommitsizeaudit
git:20251215.00f9d86 latest2025-12-15 00f9d86 116,583 BA view · diff
git:20251215.42bb27a2025-12-15 42bb27a 97,716 BA view · diff
git:20251213.4dbce2f2025-12-13 4dbce2f 92,524 BA view · diff
git:20251213.e38f6ec2025-12-13 e38f6ec 91,294 BA view · diff
git:20251213.7768ca72025-12-13 7768ca7 89,458 BA view

Audit of the latest version

A  14 of 14 checks passed. Fixed automatic checks with no AI involved, so the same checks give the same answer every run.
  • pass: Size between 200 bytes and 200 KB (116583 bytes)
  • pass: No zero-width or bidi control characters
  • pass: No instruction hidden inside an HTML comment
  • pass: No link to an exfiltration or paste host
  • pass: No credential-shaped string
  • pass: No instruction to send local credentials anywhere
  • pass: No text hidden with inline styles
  • pass: No prompt-injection phrasing
  • pass: No curl or wget piped into a shell
  • pass: No recursive delete of root, home or parent
  • pass: No instruction to read or print local credentials
  • pass: No base64 blob over 200 characters
  • pass: No link to a raw IP address
  • pass: No script tag

Source

GitHub

yaoapp/yao · 8,264 stars · license a license file GitHub does not identify · pushed 2026-10-19 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_sslhplqndcarmvni
GET https://markdownregistry.com/api/v1/resolve?ref=yaoapp/yao/agent/search/DESIGN.md
GET https://markdownregistry.com/api/v1/blob/807621590eacff0b97f634e79fbe363c2d10642e99f5acf61542dbfc0820a98f

Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.

Guides: what DESIGN.md is and how agents use it · which agent file does what.

More from yaoapp/yao

DESIGN.md@agent/robot DESIGN.md file
yaoapp/yao · agent/robot/DESIGN.md
git:20260127.3ae3f54 · audit A · 8,264 stars
DESIGN.md@grpc DESIGN.md file
yaoapp/yao · grpc/DESIGN.md
git:20260304.6e68efa · audit A · 8,264 stars
DESIGN.md@openapi/agent/robot DESIGN.md file
yaoapp/yao · openapi/agent/robot/DESIGN.md
git:20260124.d590bd7 · audit A · 8,264 stars
DESIGN.md@openapi/oauth/acl DESIGN.md file
yaoapp/yao · openapi/oauth/acl/DESIGN.md
git:20251021.e96896e · audit A · 8,264 stars
DESIGN.md@openapi/otp DESIGN.md file
yaoapp/yao · openapi/otp/DESIGN.md
git:20260221.37ab2bc · audit A · 8,264 stars
DESIGN.md@sandbox/v2 DESIGN.md file
yaoapp/yao · sandbox/v2/DESIGN.md
git:20260712.568f186 · audit A · 8,264 stars
secret SKILL.md skill
yaoapp/yao · tools/secret/SKILL.md
git:20260525.b392da7 · audit C · 8,264 stars
yao-agent SKILL.md skill
yaoapp/yao · tools/skills/yao-agent/SKILL.md · Agent management expert. ALWAYS invoke this skill when you need to list available agents, download or reference agent…
git:20260513.da4a803 · audit A · 8,264 stars
yao-audio SKILL.md skill
yaoapp/yao · tools/skills/yao-audio/SKILL.md · Audio expert. ALWAYS invoke this skill when the user asks to transcribe, recognize, or convert speech/audio to text.
git:20260808.6cdccd5 · audit A · 8,264 stars
yao-board SKILL.md skill
yaoapp/yao · tools/skills/yao-board/SKILL.md · Kanban board and task query expert. ALWAYS invoke this skill when the user asks about boards, tasks, task status, or…
git:20260731.210c5de · audit A · 8,264 stars
yao-daemon SKILL.md skill
yaoapp/yao · tools/skills/yao-daemon/SKILL.md · Daemon process management — start, monitor, restart, stop long-running services. ALWAYS invoke this skill when the user…
git:20261005.9696ccb · audit A · 8,264 stars
yao-decision SKILL.md skill
yaoapp/yao · tools/skills/yao-decision/SKILL.md · Typed decision expert. ALWAYS invoke this skill when you need structured classification, scoring, or probability…
git:20260922.00b711e · audit A · 8,264 stars

Every file in yaoapp/yao

Browse by kind, by grade A, or by owner.