mcp-doc-retrieval

Search markdown and OpenAPI documentation for specific sections and endpoints.

157|31|Updated May 27, 2020
One-click install
npx skills add https://github.com/bbartling/open-fdd --skill mcp-doc-retrieval
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: mcp-doc-retrieval
Source: https://github.com/bbartling/open-fdd/tree/main/skills/mcp-doc-retrieval
Command: npx skills add https://github.com/bbartling/open-fdd --skill mcp-doc-retrieval

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill enables quick retrieval of relevant sections from extensive markdown and API documentation, improving information discovery processes.

Core Features & Use Cases

  • Documentation Search: Provides rapid search over large markdown files to locate specific information or topics.
  • API Capability Access: Allows querying of OpenAPI specifications to find endpoint details and summaries.
  • Use Case: Developers seeking specific API endpoint descriptions or documentation sections can obtain targeted information without manual browsing.

Quick Start

Use the mcp-doc-retrieval skill to search for API endpoints related to user authentication and retrieve relevant documentation sections.

Frequently Asked Questions about mcp-doc-retrieval

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I search technical markdown documentation for specific API endpoints?

To search technical markdown documentation for specific API endpoints, you can query a generated JSON index via a fastapi endpoint. This retrieves relevant sections from large markdown files and OpenAPI specifications without manual browsing, delivering targeted troubleshooting and integration information.

What is the best way to retrieve OpenAPI specifications for endpoint details?

Retrieving OpenAPI specifications for endpoint details is best handled by querying a structured JSON index through a fastapi integration. This allows developers to rapidly locate precise endpoint descriptions and summaries across complex API documentation.

Does API documentation search require fastapi integration to work?

Yes, API documentation search requires fastapi integration to deploy the querying framework. You must also generate a JSON index from your markdown and OpenAPI docs to enable the fast, accurate search functionality over your specified document index.

Can I use this documentation retrieval method for team onboarding tasks?

You can use this documentation retrieval method for team onboarding tasks, as it facilitates fast information discovery over complex markdown files. New developers can query specific technical topics and API capabilities to accelerate their integration process.

What are the limitations of using a JSON index for markdown search?

A limitation of using a JSON index for markdown search is the need to generate and deploy the index scripts before querying. It operates within a specified document index framework, meaning content remains static until the index is regenerated.

Why does my OpenAPI documentation query return empty results?

Your OpenAPI documentation query may return empty results if the JSON index generation scripts have not been run or updated. The fastapi endpoint requires a populated document index to successfully retrieve endpoint summaries and markdown sections.