MCPInstall

yuque-personal-smart-search

Search your personal Yuque knowledge bases with natural language queries and provide summarized answers with key points and source links. For personal/individual use — searches across your own documents.

Installs
338
Last 24h
—
Trending rank
—
Security
Not audited

Install

Works with every agent the skills CLI supports.

npx skills add https://github.com/yuque/yuque-plugin --skill yuque-personal-smart-search
  1. 01

    Install

    Run the command in your project. The CLI asks which agents to install for.

  2. 02

    Describe the task

    Ask your agent for something this skill covers. It loads yuque-personal-smart-search automatically when relevant.

  3. 03

    Review the result

    The agent follows the SKILL.md steps, scripts and references bundled with the skill.

SKILL.md

The instructions your agent reads when the skill is triggered.

Smart Search — Yuque Personal Knowledge Base Search & Q&A

Search across your personal Yuque knowledge bases using natural language, read relevant documents, and synthesize a clear answer with references.

When to Use

  • User asks a question that might be answered by their personal Yuque docs
  • User wants to find specific information in their own knowledge base
  • User says "搜一下我的文档", "search my Yuque", "我的知识库里有没有..."

Required MCP Tools

All tools are from the yuque-mcp server:

  • yuque_search — Search documents by keyword
  • yuque_get_doc — Read full document content by slug/id

Workflow

Step 1: Extract Search Keywords

From the user's natural language query, extract 1-3 concise Chinese keywords. Yuque search works best with short, specific terms.

Examples:

  • "我的部署流程文档在哪?" → keywords: 部署流程
  • "How do I handle error logging?" → keywords: 错误日志 or 日志处理
  • "我之前写的技术评审笔记" → keywords: 技术评审

Step 2: Search Documents

Call yuque_search with the extracted keywords:

Tool: yuque_search
Parameters:
  query: "<keywords>"
  type: "doc"

If the search returns no results:

  1. Try alternative keywords (synonyms, broader terms)
  2. Try splitting compound terms (e.g., "部署流程" → "部署" or "流程")
  3. If still no results, tell the user honestly: "在你的语雀知识库中未找到相关文档,建议尝试其他关键词或确认文档是否存在。"

Step 3: Filter and Rank Results

From the search results, select the top 3-5 most relevant documents based on:

  • Title relevance to the query
  • Document update time (prefer recent)
  • Repository context (focus on user's personal repos)

Step 4: Read Document Content

For each selected document, fetch the full content:

Tool: yuque_get_doc
Parameters:
  repo_id: "<namespace>"    # e.g., "username/my-notes" (from search result's book.namespace)
  doc_id: "<slug>"          # e.g., "api" (from search result's target.slug)

Note: The search result contains nested data. Extract these key fields:

  • target.slug → use as doc_id
  • target.book.namespace → use as repo_id
  • target.title → document title
  • target.updated_at → last update time

Read up to 3 documents. If the first document fully answers the question, you may skip the rest.

Step 5: Synthesize and Respond

Compose the answer in the following format:

## 回答

[直接回答用户的问题,2-4 句话,简洁明了]

## 关键要点

- **要点 1**:[从文档中提取的关键信息]
- **要点 2**:[从文档中提取的关键信息]
- **要点 3**:[从文档中提取的关键信息]

## 参考文档

1. [文档标题](文档链接) — 来自「知识库名称」,更新于 YYYY-MM-DD
2. [文档标题](文档链接) — 来自「知识库名称」,更新于 YYYY-MM-DD

Guidelines

  • Always answer in the same language the user used (Chinese or English)
  • Quote specific content from documents when relevant — use > blockquotes
  • If documents contain conflicting information, note the discrepancy and mention which doc is more recent
  • If the answer is only partially found, say what you found and what's missing
  • Never fabricate information not present in the documents
  • Include document links so the user can read the full source
  • This skill searches the user's personal knowledge bases — for team knowledge bases, use the smart-search skill in the yuque-group plugin

Error Handling

SituationAction
yuque_search returns emptyTry alternative keywords, then inform user
yuque_get_doc fails (404)Skip this doc, note it may have been deleted
yuque_get_doc fails (403)Tell user they may lack permission to access this doc
API timeoutRetry once, then inform user of connectivity issue
Too many resultsFocus on top 3 by relevance, mention there are more results available

FAQ

What does the yuque-personal-smart-search skill do?

Search your personal Yuque knowledge bases with natural language queries and provide summarized answers with key points and source links. For personal/individual use — searches across your own documents.

How do I install yuque-personal-smart-search?

Run npx skills add https://github.com/yuque/yuque-plugin --skill yuque-personal-smart-search in your project. The skills CLI detects the agents you use and copies the skill into the right folder. For Claude Code you can also place the skill folder at ~/.claude/skills/yuque-personal-smart-search/ (personal) or .claude/skills/yuque-personal-smart-search/ (project).

Which AI agents can use yuque-personal-smart-search?

Any agent that supports the open Agent Skills format (a folder with a SKILL.md file), including Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, Windsurf, Cline, OpenCode and more.

Is yuque-personal-smart-search safe to install?

No partner security audit is available yet. Skills can run commands and scripts, so read the SKILL.md and any bundled files before installing.

Who maintains yuque-personal-smart-search?

It is published by yuque in yuque/yuque-plugin. It has 338 recorded installs.

More from yuque/yuque-plugin

View all →

Discover connections between documents, build knowledge networks, and establish bidirectional links across your personal Yuque knowledge base. For personal/individual use — operates on your own docs.

Docs & Writing655 installs

Open the skill to read its SKILL.md instructions.

325 installs

Generate intelligent summaries for Yuque knowledge bases or multiple documents, providing a quick overview of content landscape and key insights. For personal/individual use — summarizes your own knowledge bases.

292 installs

Open the skill to read its SKILL.md instructions.

257 installs

Open the skill to read its SKILL.md instructions.

240 installs

yuque-personal-note-refine

yuque/yuque-plugin

Open the skill to read its SKILL.md instructions.

167 installs

Popular other skills

View category →

hyperframes-cli

heygen-com/hyperframes

The HyperFrames CLI by job - scaffold, check, look at frames, edit the timeline, preview, render locally or in the cloud, publish, project history - plus reading its JSON and recovering from build or render failures.

1.3M installs

triage

mattpocock/skills

Move issues and external PRs through a state machine of triage roles, categorise, verify, grill if needed, and write agent-ready briefs.

1M installs

ask-matt

mattpocock/skills

Ask which skill or flow fits your situation. A router over the skills in this repo.

778.4K installs

to-questionnaire

mattpocock/skills

Turn a decision you can't fully answer into a questionnaire for someone else to fill in.

508.9K installs

wait-what

mattpocock/skills

Stop. That last message did not land: re-pitch it.

459.7K installs

loop-me

mattpocock/skills

Grill me about specs for the workflows I want to build, within this workspace.

447.9K installs