From aaac16ff9ab459dbbacf962f3f63f3574d06ec9e Mon Sep 17 00:00:00 2001 From: Adam Fourney Date: Mon, 24 Mar 2025 23:46:58 -0700 Subject: [PATCH] Updated README --- packages/markitdown-mcp/README.md | 50 +++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) diff --git a/packages/markitdown-mcp/README.md b/packages/markitdown-mcp/README.md index 812180e..65b6409 100644 --- a/packages/markitdown-mcp/README.md +++ b/packages/markitdown-mcp/README.md @@ -4,6 +4,56 @@ ![PyPI - Downloads](https://img.shields.io/pypi/dd/markitdown) [![Built by AutoGen Team](https://img.shields.io/badge/Built%20by-AutoGen%20Team-blue)](https://github.com/microsoft/autogen) +The `markitdown-mcp` package provides a lightweight SSE MCP server for calling MarkItDown. + +It exposes one tool: `convert_to_markdown(uri)`, where uri can be any `http:`, `https:`, `file:`, or `data:` URI. + +## Installation + +To install the package, use pip: + +```bash +pip install markitdown-mcp +``` + +## Usage + +To run the MCP server, use the following command: + +```bash +markitdown-mcp --host 127.0.0.1 --port 3001 +``` + +## Accessing from Claude Desktop + +TODO + +## Debugging + +To debug the MCP server you can use the `mcpinspector` tool. + +```bash +npx @modelcontextprotocol/inspector +``` + +You can then connect to the insepctor through the specified host and port (e.g., `http://localhost:5173/`). + +Then: +* select `SSE` as the transport type, +* input `http://127.0.0.1:3001/sse` as the URL, and +* click `Connect` + +Finally: +* click the `Tools` tab, +* click `List Tools`, +* click `convert_to_markdown`, and +* run the tool on any valid URI. + +## Security Considerations + +The server does not support authentication, and runs with the privileges of the user running it. It is recommended to run the server bound to `localhost` (default). + + ## Trademarks This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft