feat: expose knowledge-base documentation through an MCP server
维护者通常 1 天内回复
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 35/100
- Issue 类型
- 功能
- 描述清晰度
- 基本清楚
- 活跃度
- 活跃
- 技术栈
- javascript
- 领域
- api, documentation
调研方向
Start by locating the existing static build pipeline and the generated documentation data it produces. Then map the proposed MCP adapter over that catalog and search index; done means the listed resources, tools, schemas, bounded reads, deterministic search behavior, tests, and deployment documentation satisfy the acceptance criteria.
由索引模型根据 Issue 内容生成。
描述
Feature Description
Provide an MCP server for the knowledge base so AI agents and other MCP-compatible clients can discover documentation and retrieve relevant documents without scraping rendered HTML.
The server should expose the documentation catalog as MCP Resources and provide agent-friendly discovery/search operations:
- List available documentation, with stable identifiers, title, app, description, tags, route, MIME type, and modification metadata.
- Search documentation by keyword and return ranked, bounded matches with excerpts and canonical document resource URIs.
- Allow clients to fetch a selected document through
resources/read.
Problem / Opportunity
The knowledge base aggregates documentation into a browser-oriented static site. Agentic clients need a protocol-native, structured interface for retrieval-augmented workflows: first discover/search available material, then fetch only relevant content.
A standard MCP surface makes this capability pluggable across compatible agents and clients, rather than coupling consumers to one UI, scraper, or proprietary API.
Acceptance Criteria
- An MCP server can be run/configured against a built knowledge-base deployment or its generated documentation index.
- Server advertises MCP
resourcesandtoolscapabilities. -
resources/listexposes a deterministic, paginated document catalog using stablekb://URIs. -
resources/readreturns requested document content and metadata for a catalog URI. - A
list_documentstool supports filtered catalog discovery (for example app, tag, or title). - A
search_documentstool accepts a keyword query and optional filters, pagination, and result limit. - Search results return deterministic ranking plus structured metadata: document URI, title, app/slug, route, excerpt, and relevance score.
- Tool outputs use JSON Schemas and return schema-valid structured content, with compatible text content where needed.
- Search and document reads enforce bounded response sizes and clear errors for unknown or inaccessible resources.
- Build/deployment produces required search/catalog data without runtime HTML scraping.
- Server validates inputs, applies access controls appropriate to deployment, rate-limits requests, and sanitizes returned content.
- Automated tests cover resource listing/reading, search ranking/filtering/pagination, schemas, deterministic ordering, and error handling.
- Documentation explains supported transport/configuration, MCP client setup, URI format, tool schemas, and security/operational limits.
Proposed Solution
Generate a normalized document catalog and search index during the existing static build pipeline. Implement a separate MCP adapter over that generated data so retrieval behavior stays independent from browser rendering and can be deployed or embedded using a supported MCP transport.
Use two complementary MCP primitives:
- Resources for canonical documents. Each document receives a stable
kb://URI, appears inresources/list, and is retrieved throughresources/read. - Tools for agent-directed discovery:
list_documentsfor filtered catalog enumeration.search_documentsfor ranked keyword search.
Search responses should return compact structured matches and resource links, enabling an agent to request full content only after selecting relevant results. Keep tool names server-namespaced and output schemas explicit to support aggregation with other MCP servers.
Evaluate whether resource-list change notifications should be enabled for deployments where documentation updates without server restart.
Dependencies / Related
- MCP Resources specification: https://modelcontextprotocol.io/specification/2026-07-28/server/resources
- MCP Tools specification: https://modelcontextprotocol.io/specification/2026-07-28/server/tools
- MCP architecture overview: https://modelcontextprotocol.io/docs/2026-07-28/learn/architecture
No existing MCP-related issue found in this repository.
Additional Context
Research findings:
- MCP Resources fit canonical documentation: clients can list resources, select them explicitly or automatically, and retrieve content by URI.
- MCP Tools fit parameterized search because keyword input, filters, ranking, and bounded result sets are actions rather than static documents.
- MCP requires deterministic list order and supports pagination/caching, useful for large documentation catalogs and agent prompt caching.
- Tool output schemas improve interoperability; structured search matches should be paired with readable text output for broad client compatibility.
- MCP security guidance requires input validation, access control, rate limiting, output sanitization, and client-side validation of untrusted tool results.
- 主要语言
- JavaScript
- 星标
- 0
- 派生
- 0
- 平均合并
- 20 分钟
- 30 天内合并 PR
- 8
环境准备
- 提供 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
AbsaOSS/knowledge-base 的其他 Issue
-
enhancement
难度 5/5 一周以上 新手友好度 30/100
AbsaOSS/knowledge-base#118 ·
维护者通常 1 天内回复
-
enhancement
难度 4/5 3-5 天 新手友好度 52/100
AbsaOSS/knowledge-base#114 · 1 个 reaction ·
维护者通常 1 天内回复
-
难度 5/5 一周以上 新手友好度 35/100
AbsaOSS/knowledge-base#113 ·
维护者通常 1 天内回复
-
Dynamic responsive masthead menu from documentation manifests可能已有人在做 @oto-macenauer-absa 于 18 天前认领。 未关闭enhancement
难度 4/5 3-5 天 新手友好度 48/100
AbsaOSS/knowledge-base#111 · 已指派 1 人 ·
维护者通常 1 天内回复
查看 AbsaOSS/knowledge-base 的全部 Issue
相似的 Issue
-
documentation v2
难度 2/5 1-3 小时 新手友好度 78/100
modelcontextprotocol/servers#5170 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 72/100
SwiftKickMobile/skai#84 ·
-
bug
难度 2/5 1-3 小时 新手友好度 72/100
Billionmail/BillionMail#389 ·
-
难度 1/5 1 小时以内 新手友好度 92/100
Uniswap/tokenlists-org#3331 ·
-
beginner-friendly category:finding-titles community enhancement first-timers-only good first issue hacktoberfest help wanted low hanging fruit micro-contribution type: task up-for-grabs
难度 1/5 1-3 小时 新手友好度 85/100
Berserk-hub150/skillhawk#227 · 1 条评论 ·
维护者通常 8 天内回复