Small changes to favor streamable HTTP over deprecated SSE (#1264)

This commit is contained in:
afourney
2025-05-23 11:39:41 -07:00
committed by GitHub
parent effde4767b
commit 9dc982a3b1
2 changed files with 22 additions and 13 deletions

View File

@@ -4,7 +4,7 @@
![PyPI - Downloads](https://img.shields.io/pypi/dd/markitdown-mcp)
[![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 STDIO, SSE and Streamable HTTP MCP server for calling MarkItDown.
The `markitdown-mcp` package provides a lightweight STDIO, Streamable HTTP, and 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.
@@ -25,10 +25,10 @@ To run the MCP server, using STDIO (default) use the following command:
markitdown-mcp
```
To run the MCP server, using SSE or Streamable HTTP use the following command:
To run the MCP server, using Streamable HTTP and SSE use the following command:
```bash
markitdown-mcp --sse --host 127.0.0.1 --port 3001
markitdown-mcp --http --host 127.0.0.1 --port 3001
```
## Running in Docker
@@ -109,16 +109,16 @@ If using STDIO:
* input `markitdown-mcp` as the command, and
* click `Connect`
If using SSE:
* select `SSE` as the transport type,
* input `http://127.0.0.1:3001/sse` as the URL, and
* click `Connect`
If using Streamable HTTP:
* select `Streamable HTTP` as the transport type,
* input `http://127.0.0.1:3001/mcp` as the URL, and
* click `Connect`
If using SSE:
* 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`,