Docs Knowledge Assistant

Docs Q&A agent for Eve.

What is Docs Knowledge Assistant?

Docs Knowledge Assistant is an Eve agent that Answers from your repo docs and cites the file. It is for Eve developers answering product questions. Preview every file on this page, then install with npx shadcn@latest add @evex/docs-knowledge-assistant. Docs Knowledge Assistant is an eve agent that answers questions from the installing repository's documentation files.

Answers from your repo docs and cites the file.

Other package managers

Prefer pnpm, yarn, or bun? Copy the matching install command.

npx shadcn@latest add @evex/docs-knowledge-assistant

Category: support
Files: 15 files
Requires: 2 dependencies
Updated: Aug 26, 2026

What's included

15 files1 skill file4 tools

Dependencies:eve@^0.31.3zod@4.3.6

About Docs Knowledge Assistant

Docs Knowledge Assistant is an eve agent that answers questions from the installing repository's documentation files. It searches README, docs/, CONTRIBUTING*, and AGENTS.md, then replies with file-path citations so readers can verify the source.

You interact with it through Eve chat sessions or by mentioning it on a GitHub issue comment. It ignores pull request conversations, never publishes GitHub PR reviews, and never applies taxonomy labels or triage other issues.

When the documentation clearly lacks an answer, it says so. On GitHub issue-comment turns it can optionally open a documentation-gap issue with open_docs_issue so maintainers can track missing docs without turning the agent into a second issue bot.

How it works

A user asks a documentation question in Eve chat, or mentions @docs-knowledge-assistant on a GitHub issue comment matching GITHUB_APP_SLUG.
The GitHub channel rejects pull request conversations and review threads, then injects issue context for the zai/glm-5.2 model.
The agent loads the docs-qa skill when needed, then calls search_docs and read_doc, which refuse non-documentation paths and discover README.* / CONTRIBUTING.* variants at the repo root.
It answers from those files only and cites each path it relied on. write_file is disabled so the agent cannot rewrite the repository as an answer.
If the docs do not cover the question, it says so. On GitHub issue-comment turns only, a clear gap may call open_docs_issue once; Eve chat receives readyToOpen false because no GitHub publisher runs there. The channel creates the issue through the GitHub Issues API without applying taxonomy labels.
Evals cover answering with a README citation, saying not-in-docs, and refusing PR review or labeling requests.

Use cases

Install and setup questions from README

New contributors ask how to install or configure the project in Eve chat. The agent reads README.md or docs/install.md and answers with the cited path instead of guessing from source.

Contributor workflow questions on GitHub issues

Mention the bot on an issue asking about contribution steps. It answers from CONTRIBUTING* or AGENTS.md and posts the cited reply on the issue timeline.

Honest gaps when docs are silent

When someone asks about on-call policy or an undocumented API, the agent says the docs do not cover it rather than inventing steps from application source.

Track missing documentation

When a recurring question on a GitHub issue has no docs home, open_docs_issue creates a focused documentation issue so maintainers can fill the gap without labeling or triaging other work.

Requirements

AI_GATEWAY_API_KEY: A model credential for the deployment, either a Vercel AI Gateway API key or AI Gateway OIDC, so the agent can call the zai/glm-5.2 model.
GITHUB_APP_ID: Optional. The App ID of the GitHub App used for issue-comment Q&A. Needs Metadata read, Contents read, and Issues read/write. Do not grant Pull requests write.
GITHUB_APP_PRIVATE_KEY: Optional. The PEM private key for the GitHub App. When stored as a single-line variable, replace literal newlines with \n.
GITHUB_WEBHOOK_SECRET: Optional. Shared secret for verifying GitHub webhooks at /eve/v1/github. A mismatch produces HTTP 401.
GITHUB_APP_SLUG: Optional. The mention users type on GitHub, defaulting to docs-knowledge-assistant. It must match your GitHub App name.

FAQ

How do I install and ask a question?

Run npx shadcn@latest add @evex/docs-knowledge-assistant inside an eve app, set AI_GATEWAY_API_KEY, then ask documentation questions in Eve chat. For GitHub issue replies, deploy over HTTPS, create a GitHub App pointing at /eve/v1/github, and mention the bot on an issue.

Does it review pull requests or label issues?

No. The channel ignores pull request conversations, there is no PR review publication path, and it never applies taxonomy labels. Use @evex/code-reviewer for PR reviews and @evex/github-issue-maintainer for issue triage.

Which files can it read?

Only README*, docs/**, CONTRIBUTING*, and AGENTS.md. search_docs and read_doc refuse application source, tests, and config paths.

What happens when the docs do not answer?

The agent says the documentation does not cover the question. On GitHub issue-comment turns, when the gap is clear, it can call open_docs_issue to create a documentation issue without labeling other issues. Eve chat refuses that tool.

Is GitHub required?

No. Chat works with only AI_GATEWAY_API_KEY. GitHub App credentials are needed only for issue-comment Q&A and optional docs-gap issue creation.

Files this command writes

Core

Skills

Tools

npx shadcn@latest add @evex/docs-knowledge-assistant

What is Docs Knowledge Assistant?

Other package managers

Prefer pnpm, yarn, or bun? Copy the matching install command.

npx shadcn@latest add @evex/docs-knowledge-assistant

Install and setup questions from README

New contributors ask how to install or configure the project in Eve chat. The agent reads README.md or docs/install.md and answers with the cited path instead of guessing from source.

Contributor workflow questions on GitHub issues

Mention the bot on an issue asking about contribution steps. It answers from CONTRIBUTING* or AGENTS.md and posts the cited reply on the issue timeline.

Honest gaps when docs are silent

When someone asks about on-call policy or an undocumented API, the agent says the docs do not cover it rather than inventing steps from application source.

Track missing documentation

When a recurring question on a GitHub issue has no docs home, open_docs_issue creates a focused documentation issue so maintainers can fill the gap without labeling or triaging other work.

Requirements

AI_GATEWAY_API_KEY

A model credential for the deployment, either a Vercel AI Gateway API key or AI Gateway OIDC, so the agent can call the zai/glm-5.2 model.

GITHUB_APP_ID

Optional. The App ID of the GitHub App used for issue-comment Q&A. Needs Metadata read, Contents read, and Issues read/write. Do not grant Pull requests write.

GITHUB_APP_PRIVATE_KEY

Optional. The PEM private key for the GitHub App. When stored as a single-line variable, replace literal newlines with \n.

GITHUB_WEBHOOK_SECRET

Optional. Shared secret for verifying GitHub webhooks at /eve/v1/github. A mismatch produces HTTP 401.

GITHUB_APP_SLUG

Optional. The mention users type on GitHub, defaulting to docs-knowledge-assistant. It must match your GitHub App name.

FAQ

How do I install and ask a question?

Does it review pull requests or label issues?

Which files can it read?

Only README*, docs/**, CONTRIBUTING*, and AGENTS.md. search_docs and read_doc refuse application source, tests, and config paths.

What happens when the docs do not answer?

Is GitHub required?

No. Chat works with only AI_GATEWAY_API_KEY. GitHub App credentials are needed only for issue-comment Q&A and optional docs-gap issue creation.

Docs Knowledge Assistant

What is Docs Knowledge Assistant?

Other package managers

What's included

About Docs Knowledge Assistant

How it works

Use cases

Install and setup questions from README

Contributor workflow questions on GitHub issues

Honest gaps when docs are silent

Track missing documentation

Requirements

FAQ

How do I install and ask a question?

Does it review pull requests or label issues?

Which files can it read?

What happens when the docs do not answer?

Is GitHub required?

Files this command writes

Core

.env.example.env.example9 lines

agent.tsagent/agent.ts6 lines

github.tsagent/channels/github.ts161 lines

instructions.mdagent/instructions.md43 lines

docs-paths.tsagent/lib/docs-paths.ts91 lines

answer-cite-readme.eval.tsevals/answer-cite-readme.eval.ts37 lines

evals.config.tsevals/evals.config.ts6 lines

ignore-pr-review.eval.tsevals/ignore-pr-review.eval.ts43 lines

say-not-in-docs.eval.tsevals/say-not-in-docs.eval.ts38 lines

README.mdagent/README.md114 lines

Skills

SKILL.mdagent/skills/docs-qa/SKILL.md29 lines

Tools

open_docs_issue.tsagent/tools/open_docs_issue.ts94 lines

read_doc.tsagent/tools/read_doc.ts79 lines

search_docs.tsagent/tools/search_docs.ts116 lines

write_file.tsagent/tools/write_file.ts4 lines

Docs Knowledge Assistant

What is Docs Knowledge Assistant?

Other package managers

What's included

About Docs Knowledge Assistant

How it works

Use cases

Install and setup questions from README

Contributor workflow questions on GitHub issues

Honest gaps when docs are silent

Track missing documentation

Requirements

FAQ

How do I install and ask a question?

Does it review pull requests or label issues?

Which files can it read?

What happens when the docs do not answer?

Is GitHub required?

Files this command writes

Core

.env.example.env.example9 lines

agent.tsagent/agent.ts6 lines

github.tsagent/channels/github.ts161 lines

instructions.mdagent/instructions.md43 lines

docs-paths.tsagent/lib/docs-paths.ts91 lines

answer-cite-readme.eval.tsevals/answer-cite-readme.eval.ts37 lines

evals.config.tsevals/evals.config.ts6 lines

ignore-pr-review.eval.tsevals/ignore-pr-review.eval.ts43 lines

say-not-in-docs.eval.tsevals/say-not-in-docs.eval.ts38 lines

README.mdagent/README.md114 lines

Skills

SKILL.mdagent/skills/docs-qa/SKILL.md29 lines

Tools

open_docs_issue.tsagent/tools/open_docs_issue.ts94 lines

read_doc.tsagent/tools/read_doc.ts79 lines

search_docs.tsagent/tools/search_docs.ts116 lines

write_file.tsagent/tools/write_file.ts4 lines

Related Agents

Brand Visual Asset Generator

Code Reviewer

Branded SEO Page Builder

Related Agents

Brand Visual Asset Generator