feat: expose knowledge-base documentation through an MCP server
メンテナーはふだん 1 日以内に返信
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 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分
- マージ済み PR(30日)
- 8
環境構築
- Dockerfile または Docker Compose ファイルあり
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
AbsaOSS/knowledge-base のほかの issue
-
enhancement
難易度 5/5 1週間以上 初心者へのやさしさ 30/100
AbsaOSS/knowledge-base#118 ·
メンテナーはふだん 1 日以内に返信
-
enhancement
難易度 4/5 3〜5日 初心者へのやさしさ 52/100
AbsaOSS/knowledge-base#114 · リアクション 1 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 5/5 1週間以上 初心者へのやさしさ 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
-
area:plugins enhancement platform:vscode
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
anthropics/claude-code#103166 ·
メンテナーはふだん 1 日以内に返信
-
Add: Kids Zone Logoオープンcheck:failed logos:add
難易度 1/5 1時間未満 初心者へのやさしさ 78/100
-
[workshop-sim] Improve: Add verifiable checkpoint and bridge to Step 5 (What Are Agentic Workflows?)オープンfeedback simulation workshop
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
githubnext/gh-aw-workshop#4715 ·
メンテナーはふだん 1 日以内に返信
-
getComputedStyle ignores a rule whose selector list contains a pseudo-element (regression in 30.x)対応中かも @chiragjangiir が今日担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 80/100
メンテナーはふだん 1 日以内に返信
-
external-plugin external-plugin-canvas needs-review:MEDIUM ready-for-review
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
github/awesome-copilot#5153 · コメント 2 件 ·
メンテナーはふだん 1 日以内に返信