Docs Chatbot

Summary

The Docs Chatbot Agent answers questions about a code library's API. It looks up structured function documentation — signatures, parameters, and examples — and answers using only what the docs say. Reach for it to drop a grounded "ask the docs" assistant into a docs site, an IDE, or a support channel.

Install

bunnpmpnpmyarn
$ pnpm dlx shadcn@latest add @agentcn/eve/docs-chatbot
Copy

Composition

Copyagent/
├── agent.ts             # Agent definition (model + config)
├── instructions.md      # Docs-grounded answering instructions
├── data/
│   └── functions.json   # Sample documentation source
└── tools/
    └── lookup_docs.ts   # Looks up functions by name or keyword

Customization

• Point at your docs. Replace data/functions.json with your generated API docs (e.g. from TypeDoc), or change lookup_docs to fetch from a remote source.
• Improve matching. Swap the substring filter for embeddings-based search to handle paraphrased questions.
• Expose it as MCP. Wrap lookup_docs in an MCP server so other clients can query the same docs.
• Swap the model. Edit agent/agent.ts.