Skip to content

docs: correct minor typos #1173

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+5 −5
Open

docs: correct minor typos #1173

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions packages/markitdown-mcp/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,14 @@ pip install markitdown-mcp

## 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
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
markitdown-mcp --sse --host 127.0.0.1 --port 3001
Expand Down Expand Up @@ -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.

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:

Expand Down Expand Up @@ -102,7 +102,7 @@ To debug the MCP server you can use the `mcpinspector` tool.
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:
* select `STDIO` as the transport type,
Expand All @@ -122,7 +122,7 @@ Finally:

## 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
Expand Down