thibaudcolas / thibaudcolas/draftail.org

MCP docs server for Draftail and Draft.js

Open
#147 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

documentation enhancement infrastructure low medium effort
Dominant language
TypeScript
Stars
9
Forks
4
PR merge metrics
No merged PRs in 30d

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:

  1. Resources: Documentation pages, API references, guides
  2. Tools: Search documentation, get specific topics, retrieve examples
  3. 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

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

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review follow-up issue #144, the existing llms.txt implementation, and the generated markdown files from docusaurus-plugin-llms. Compare the static, dynamic, and hybrid approaches and determine how Draftail and Draft.js content should be exposed. Done means an installable MCP server, documentation access and search capabilities, usage documentation, and npm publication or local installation.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.