docs: add 'Use with AI Agents' section to README#2219
Open
raccioly wants to merge 1 commit into
Open
Conversation
Points readers to the official markitdown-mcp server and to community-maintained Agent Skills for CLI coding agents (ref microsoft#1810). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a short Use with AI Agents section to the README (right after Docker, before Contributing) that:
packages/markitdown-mcpMCP server, which currently isn't mentioned anywhere in the top-level README.Motivation
MarkItDown's README explains it is built "for use with LLMs" — but a reader landing on the repo has no pointer for how to wire it into an AI agent, even though the repo itself ships an MCP server. This closes that gap in 11 lines with zero maintenance burden (community links carry a disclaimer, mirroring the existing
#markitdown-plugindiscovery pattern for plugins).Related
Docs-only change — no code, no tests affected.
🤖 Generated with Claude Code