Guide · Agent skill
How to use the Knowledge Base Search agent skill
Updated · written with AI from the project's own documentation and checked against our catalogue data
The Knowledge Base Search skill (skill name: knowledge-base) lets an AI agent answer questions from the document collections configured in a Yuxi platform instance, instead of relying only on what it already knows. This guide is for people who have never installed an agent skill and for developers who run Yuxi. By the end you will know what the skill needs, how to install it, how to phrase requests so the agent uses it, and how to check the sources it returns.
Quick start
- 1Confirm your Yuxi setup. Make sure the Yuxi platform is running, the 'knowledge' MCP server is connected, and at least one knowledge base is enabled with documents in it.
- 2Download the ZIP. Download the knowledge-base skill ZIP from this page and unzip it so that SKILL.md is in a skill folder.
- 3Place the skill folder. Copy the folder to ~/.claude/skills/ for personal use or to .claude/skills/ in your project. Alternatively, upload the ZIP under Settings → Capabilities → Skills in the Claude apps.
- 4Ask a question about your documents. Write a request that names the subject and the knowledge base, for example asking for a policy answer from your onboarding materials.
- 5Check the cited source. Read the file name and passage the agent cites, and open the document if the snippet looks partial.
What is an agent skill and what does this one do?
An agent skill is a folder containing a SKILL.md file that tells an AI agent when and how to use a set of tools. This skill is designed for questions that should be answered from your own stored documents. Once it is installed, the agent can list the knowledge bases you can access, search them, open full document passages when a snippet is not enough, and find specific terms or sections inside a document.
The skill also instructs the agent to say where an answer came from (which knowledge base, file or passage) and not to make up knowledge base or file IDs. Its own instructions note that a single retrieved chunk may not reflect the whole document.
- list_kbs: lists the knowledge bases available in the current session that are enabled.
- query_kb: searches a chosen knowledge base and returns file IDs and relevant snippets.
- open_kb_document: opens the original document window for more surrounding context.
- find_kb_document: locates keywords or regular-expression matches inside a known document.
- search_file: searches knowledge base files by file name, within one knowledge base or across several.
What you need before installing
The skill only searches documents that already exist in a Yuxi knowledge base, so three things must be in place. The skill's requirements list a running Yuxi platform instance with the 'knowledge' MCP server connected, at least one configured and enabled knowledge base, and user permissions set in Yuxi that allow access to those knowledge bases.
The skill uses the network, because it calls the Yuxi platform's tools. It does not run scripts.
- A running Yuxi platform instance
- The 'knowledge' MCP server connected to that instance
- One or more configured and enabled knowledge bases with documents uploaded
- User permissions in Yuxi that cover the knowledge bases you want searched
Install the knowledge-base skill
Download the skill ZIP from this page and unzip it. The skill folder contains SKILL.md. Then choose one of the following locations, depending on whether you want it for yourself or for one project.
For a personal install, place the unzipped skill folder in ~/.claude/skills/. For a project install, place it in the project's .claude/skills/ folder. In the Claude apps, you can instead upload the ZIP under Settings → Capabilities → Skills.
- Personal: ~/.claude/skills/
- Project: .claude/skills/ inside your project folder
- Claude apps: Settings → Capabilities → Skills, then upload the ZIP
How to trigger the skill with natural requests
You do not need a special command. The skill is meant to be used when you ask the agent to answer from your project knowledge base, internal materials, uploaded documents or knowledge-graph content, or when you ask it to verify facts or quote passages from your reference materials. Name the subject clearly so the agent can choose the right knowledge base.
If the answer seems to come from general knowledge rather than your documents, ask the agent to search the knowledge base explicitly and to say which file the answer came from.
- "Using our onboarding knowledge base, what is the probation period for new staff?"
- "Check the product spec documents and quote the section on data retention."
- "Find where the internal handbook mentions expense limits and tell me the file name."
- "Search the knowledge base for the term 'SLA' and show me each passage that uses it."
How the agent works through a question
The skill sets a simple workflow. The agent first confirms which knowledge bases are available, then picks the most relevant one and runs a search. If a result shows a chunk count of 1, the file has only one chunk and the snippet is usually enough. If the count is greater than 1 and the snippet does not answer the question, the agent opens the document for context using the returned file ID. A missing or zero chunk count means unknown, so it is not treated as proof that a document is complete.
When you need a specific term, metric or section, the agent uses find_kb_document inside candidate documents.
Safety, limits and tips
The skill only reaches knowledge bases allowed by the current session configuration and the user's permissions. It is not a source of current public information, because it searches only your stored documents.
Some external read-only knowledge bases, such as Dify, may support search only and not full-text opening or in-document search. When the tools report such a limit, the agent is instructed to tell you rather than guess.
Because a retrieved snippet can be partial, check important answers against the cited passage before relying on them.
- Ask for the source file and passage in every request where accuracy matters.
- If an answer is vague, ask the agent to open the document for more context.
- Use find_kb_document when you already know the term or section you need.
- Remember that the skill uses the network to reach your Yuxi instance.
What people use it for
- Answering staff questions from an internal handbook or policy collection.
- Verifying a figure or claim against uploaded reference documents before reusing it.
- Quoting the exact wording of a contract clause or specification section.
- Finding every place a term such as a product code or metric appears in a document.
- Testing retrieval quality on a Yuxi deployment by checking which files a query returns.
Frequently asked questions
How do I install the knowledge-base agent skill?
Download the skill ZIP from this page and unzip it. Place the folder in ~/.claude/skills/ for personal use or in a project's .claude/skills/ folder. In the Claude apps you can instead upload the ZIP under Settings → Capabilities → Skills.
What do I need to use this skill?
You need a running Yuxi platform instance with the 'knowledge' MCP server connected, at least one configured and enabled knowledge base, and user permissions in Yuxi that allow access to it. Without these, the tools have nothing to query.
Is the knowledge-base skill free to use?
The source material for this page states the licence as MIT. It does not state pricing, so check the repository and your own Yuxi deployment for any cost details.
Does the skill search the public internet?
No. It searches only the documents stored in your Yuxi knowledge bases. For current public information you need a different tool.
Why does the agent sometimes open a whole document?
If a search result shows more than one chunk and the snippet does not answer the question, the agent opens the document to read more context. A chunk count of 1 usually means the snippet is enough.
Can I use this skill with external knowledge bases like Dify?
Possibly, but with limits. External read-only knowledge bases may support search only, not full-text opening or in-document search. If a limit applies, the agent is instructed to tell you.
New agent skills, repos and AI tools — every week
The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.
Our verdict
Choose this skill if your team already stores internal documents in a Yuxi knowledge base and wants answers that point back to specific files and passages. Pick something else if you do not run Yuxi, need current public information, or need answers you can trust without checking the cited sources.
Download the skill