Skip to content

Commit 2aed967

Browse files
committed
[main] updating README.md files
1 parent 2de7920 commit 2aed967

File tree

6 files changed

+14
-2
lines changed

6 files changed

+14
-2
lines changed

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,16 @@
11
# MCP Client for Ollama
22

33
[![Python 3.10+](https://img.shields.io/badge/Python-3.10+-blue.svg)](https://www.python.org/downloads/)
4-
![PyPI - Python Version](https://img.shields.io/pypi/v/ollmcp?label=ollmcp-pypi)
5-
![PyPI - Python Version](https://img.shields.io/pypi/v/mcp-client-for-ollama?label=mcp-client-for-ollama-pypi)
4+
[![PyPI - Python Version](https://img.shields.io/pypi/v/ollmcp?label=ollmcp-pypi)](https://pypi.org/project/ollmcp/)
5+
[![PyPI - Python Version](https://img.shields.io/pypi/v/mcp-client-for-ollama?label=mcp-client-for-ollama-pypi)](https://pypi.org/project/mcp-client-for-ollama/)
66
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
7+
[![Build, Publish and Release](https://github.com/jonigl/mcp-client-for-ollama/actions/workflows/publish.yml/badge.svg)](https://github.com/jonigl/mcp-client-for-ollama/actions/workflows/publish.yml)
8+
[![CI](https://github.com/jonigl/mcp-client-for-ollama/actions/workflows/ci.yml/badge.svg)](https://github.com/jonigl/mcp-client-for-ollama/actions/workflows/ci.yml)
79

810
A simple yet powerful Python client for interacting with Model Context Protocol (MCP) servers using Ollama, allowing local LLMs to use tools.
911

12+
![ollmpc usage demo gif](misc/ollmcp-demo.gif)
13+
1014
## Overview
1115

1216
This project provides a robust Python-based client that connects to one or more Model Context Protocol (MCP) servers and uses Ollama to process queries with tool use capabilities. The client establishes connections to MCP servers, sends queries to Ollama models, and handles the tool calls the model makes.
@@ -95,6 +99,8 @@ uv run client.py --servers-json /path/to/servers.json --model llama3.2:1b
9599

96100
During chat, use these commands:
97101

102+
![ollmcp main interface](misc/ollmcp-welcome.jpg)
103+
98104
| Command | Shortcut | Description |
99105
|---------|----------|-------------|
100106
| `help` | `h` | Display help and available commands |
@@ -113,6 +119,8 @@ During chat, use these commands:
113119

114120
The tool and server selection interface allows you to enable or disable specific tools:
115121

122+
![ollmcp model selection interface](misc/ollmpc-model-selection.jpg)
123+
116124
- Enter **numbers** separated by commas (e.g. `1,3,5`) to toggle specific tools
117125
- Enter **ranges** of numbers (e.g. `5-8`) to toggle multiple consecutive tools
118126
- Enter **S + number** (e.g. `S1`) to toggle all tools in a specific server
@@ -126,6 +134,8 @@ The tool and server selection interface allows you to enable or disable specific
126134

127135
The model selection interface shows all available models in your Ollama installation:
128136

137+
![ollmcp tool and server selection interface](misc/ollmpc-tool-and-server-selection.jpg)
138+
129139
- Enter the **number** of the model you want to use
130140
- `s` or `save` - Save the model selection and return to chat
131141
- `q` or `quit` - Cancel the model selection and return to chat

cli-package/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
A command-line interface for connecting to MCP servers using Ollama.
44

5+
![alt text](../misc/ollmcp-welcome.jpg)
6+
57
## Installation
68

79
```

misc/ollmcp-demo.gif

18.8 MB
Loading

misc/ollmcp-welcome.jpg

117 KB
Loading

misc/ollmpc-model-selection.jpg

108 KB
Loading
120 KB
Loading

0 commit comments

Comments
 (0)