luciano/markitdown
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: correct minor typos

Browse source
This commit is contained in:
Dmitry 2025-04-08 19:29:46 +03:00 committed by GitHub
parent 3fcd48cdfc
commit cce7e845fd
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
packages/markitdown-mcp/README.md
View file

@ -18,14 +18,14 @@ pip install markitdown-mcp
## Usage ## Usage
To run the MCP server, ussing STDIO (default) use the following command: To run the MCP server, using STDIO (default) use the following command:
```bash ```bash
markitdown-mcp markitdown-mcp
``` ```
To run the MCP server, ussing SSE use the following command: To run the MCP server, using SSE use the following command:
```bash ```bash
markitdown-mcp --sse --host 127.0.0.1 --port 3001 markitdown-mcp --sse --host 127.0.0.1 --port 3001
@ -54,7 +54,7 @@ Once mounted, all files under data will be accessible under `/workdir` in the co
It is recommended to use the Docker image when running the MCP server for Claude Desktop. It is recommended to use the Docker image when running the MCP server for Claude Desktop.
Follow [these instrutions](https://modelcontextprotocol.io/quickstart/user#for-claude-desktop-users) to access Claude's `claude_desktop_config.json` file. Follow [these instructions](https://modelcontextprotocol.io/quickstart/user#for-claude-desktop-users) to access Claude's `claude_desktop_config.json` file.
Edit it to include the following JSON entry: Edit it to include the following JSON entry:
@ -102,7 +102,7 @@ To debug the MCP server you can use the `mcpinspector` tool.
npx @modelcontextprotocol/inspector npx @modelcontextprotocol/inspector
``` ```
You can then connect to the insepctor through the specified host and port (e.g., `http://localhost:5173/`). You can then connect to the inspector through the specified host and port (e.g., `http://localhost:5173/`).
If using STDIO: If using STDIO:
* select `STDIO` as the transport type, * select `STDIO` as the transport type,
@ -122,7 +122,7 @@ Finally:
## Security Considerations ## Security Considerations
The server does not support authentication, and runs with the privileges if the user running it. For this reason, when running in SSE mode, it is recommended to run the server bound to `localhost` (default). The server does not support authentication, and runs with the privileges of the user running it. For this reason, when running in SSE mode, it is recommended to run the server bound to `localhost` (default).
## Trademarks ## Trademarks