Skip to content

Commit a846ade

Browse files
committed
docs: update README with new badges, container paths and transport protocol details
Signed-off-by: jbrinkman <joe.brinkman@improving.com>
1 parent 00dd62e commit a846ade

File tree

1 file changed

+16
-12
lines changed

1 file changed

+16
-12
lines changed

‎README.md‎

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# Valkey MCP Task Management Server
22

3-
[![Build and Publish Container](https://github.com/jbrinkman/valkey-ai-tasks/actions/workflows/publish-container-image.yml/badge.svg)](https://github.com/jbrinkman/valkey-ai-tasks/actions/workflows/publish-container-image.yml)
3+
[![Lint](https://github.com/jbrinkman/valkey-ai-tasks/actions/workflows/lint.yml/badge.svg)](https://github.com/jbrinkman/valkey-ai-tasks/actions/workflows/lint.yml)
4+
[![Publish Container](https://github.com/jbrinkman/valkey-ai-tasks/actions/workflows/publish-container-image.yml/badge.svg)](https://github.com/jbrinkman/valkey-ai-tasks/actions/workflows/publish-container-image.yml)
5+
[![Release](https://github.com/jbrinkman/valkey-ai-tasks/actions/workflows/create-release.yml/badge.svg)](https://github.com/jbrinkman/valkey-ai-tasks/actions/workflows/create-release.yml)
46
[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)
57

68
A task management system that implements the Model Context Protocol (MCP) for seamless integration with agentic AI tools. This system allows AI agents to create, manage, and track tasks within plans using Valkey as the persistence layer.
@@ -13,6 +15,7 @@ A task management system that implements the Model Context Protocol (MCP) for se
1315
- Status tracking for tasks
1416
- Notes support with Markdown formatting for both plans and tasks
1517
- MCP server for AI agent integration
18+
- Supports STDIO, SSE and Streamable HTTP transport protocols
1619
- Docker container support for easy deployment
1720

1821
## Architecture
@@ -45,7 +48,7 @@ docker run -d --name valkey-mcp \
4548
-p 6379:6379 \
4649
-v valkey-data:/data \
4750
-e ENABLE_SSE=true \
48-
valkey-tasks-mcp-server:latest
51+
ghcr.io/jbrinkman/valkey-ai-tasks:latest
4952
```
5053

5154
#### Running with Streamable HTTP
@@ -56,7 +59,7 @@ docker run -d --name valkey-mcp \
5659
-p 6379:6379 \
5760
-v valkey-data:/data \
5861
-e ENABLE_STREAMABLE_HTTP=true \
59-
valkey-tasks-mcp-server:latest
62+
ghcr.io/jbrinkman/valkey-ai-tasks:latest
6063
```
6164

6265
#### Running with STDIO (For direct process communication)
@@ -65,7 +68,7 @@ docker run -d --name valkey-mcp \
6568
docker run -i --rm --name valkey-mcp \
6669
-v valkey-data:/data \
6770
-e ENABLE_STDIO=true \
68-
valkey-tasks-mcp-server:latest
71+
ghcr.io/jbrinkman/valkey-ai-tasks:latest
6972
```
7073

7174
### Using the Container Images
@@ -75,7 +78,7 @@ The container images are published to GitHub Container Registry and can be pulle
7578
```bash
7679
docker pull ghcr.io/jbrinkman/valkey-ai-tasks:latest
7780
# or a specific version
78-
docker pull ghcr.io/jbrinkman/valkey-ai-tasks:1.2.3
81+
docker pull ghcr.io/jbrinkman/valkey-ai-tasks:1.1.0
7982
```
8083

8184
## MCP API Reference
@@ -135,10 +138,12 @@ The server automatically selects the appropriate transport based on:
135138

136139
### Local MCP Configuration
137140

138-
To configure an AI agent to use the local MCP server, add the following to your `~/.codeium/windsurf/mcp_config.json` file:
141+
To configure an AI agent to use the local MCP server, add the following to your MCP configuration file (the exact file location depends on your AI Agent):
139142

140143
#### Using SSE Transport (Default)
141144

145+
> Note: The docker container should already be running.
146+
142147
```json
143148
{
144149
"mcpServers": {
@@ -151,12 +156,13 @@ To configure an AI agent to use the local MCP server, add the following to your
151156

152157
#### Using Streamable HTTP Transport
153158

159+
> Note: The docker container should already be running.
160+
154161
```json
155162
{
156163
"mcpServers": {
157164
"valkey-tasks": {
158-
"serverUrl": "http://localhost:8080/mcp",
159-
"transport": "streamable-http"
165+
"serverUrl": "http://localhost:8080/mcp"
160166
}
161167
}
162168
}
@@ -178,11 +184,9 @@ For agentic tools that need to start and manage the MCP server process, use a co
178184
"-i",
179185
"--rm",
180186
"-v", "valkey-data:/data"
181-
"-e", "ENABLE_SSE=false",
182-
"-e", "ENABLE_STREAMABLE_HTTP=false",
183187
"-e", "ENABLE_STDIO=true",
184-
"valkey-mcp-server"
185-
]
188+
"ghcr.io/jbrinkman/valkey-ai-tasks:latest"
189+
]
186190
}
187191
}
188192
}

0 commit comments

Comments
 (0)