-
Notifications
You must be signed in to change notification settings - Fork 3
Open
Labels
documentationType: Documentation improvements, additions, or fixesType: Documentation improvements, additions, or fixesenhancementNew feature or requestNew feature or requestinfrastructureType: CI/CD, build, deployment, toolingType: CI/CD, build, deployment, toolinglowPriority: Nice to have, when time permitsPriority: Nice to have, when time permitsmedium effortEffort: 2-8 hours of workEffort: 2-8 hours of work
Description
Summary
Create an MCP (Model Context Protocol) server to provide structured documentation access for Draftail and Draft.js to LLMs and AI assistants. Follow-up to #144
Motivation
MCP servers enable AI tools to efficiently query and retrieve documentation. This would allow:
- AI assistants (Claude, Copilot, etc.) to access up-to-date Draftail and Draft.js documentation
- Better context for developers asking questions about the editor
- Structured access to API references, guides, and examples
- Integration with AI-powered development tools
Proposed Implementation
Create an MCP server that exposes:
- Resources: Documentation pages, API references, guides
- Tools: Search documentation, get specific topics, retrieve examples
- Prompts: Common patterns and use cases
Content to Include
- Draftail documentation (from this site)
- Draft.js documentation (external reference)
- Code examples and patterns
- Migration guides
- Troubleshooting information
Technical Approach
Option 1: Static MCP Server
Build on the generated llms.txt and markdown files from docusaurus-plugin-llms
Option 2: Dynamic MCP Server
Query the documentation site directly or use the Docusaurus content layer
Option 3: Hybrid
Combine static generated files with live search capabilities
Resources
- Existing
llms.txtimplementation (from llms.txt of Draftail docs #144) - Building MCPs with Netlify
- FastMCP
Benefits
- Improved developer experience when using AI assistants
- Standardized way to access documentation programmatically
- Better discoverability of Draftail features
- Can serve both Draftail and Draft.js docs in one place
Acceptance Criteria
- MCP server implementation created
- Server can be installed and configured by developers
- Provides access to Draftail documentation
- Includes Draft.js reference documentation
- Documentation on how to use the MCP server
- Published to npm or available for local installation
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationType: Documentation improvements, additions, or fixesType: Documentation improvements, additions, or fixesenhancementNew feature or requestNew feature or requestinfrastructureType: CI/CD, build, deployment, toolingType: CI/CD, build, deployment, toolinglowPriority: Nice to have, when time permitsPriority: Nice to have, when time permitsmedium effortEffort: 2-8 hours of workEffort: 2-8 hours of work