Skip to content

Commit dade494

Browse files
committed
docs: improve README formatting and add CI build status badge
- Add a CI build status badge to the top of the README - Change feature descriptions from italic asterisks to underscores for improved Markdown consistency Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>
1 parent cf50fcb commit dade494

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# mcp-workshop
22

3+
[![build-and-test](https://github.com/go-training/mcp-workshop/actions/workflows/ci.yml/badge.svg)](https://github.com/go-training/mcp-workshop/actions/workflows/ci.yml)
4+
35
English | [繁體中文](README.zh-TW.md) | [簡體中文](README.zh-CN.md)
46

57
![cover](./images/cover.png)
@@ -34,19 +36,19 @@ This workshop consists of hands-on modules, each demonstrating a key aspect of b
3436

3537
- **[01. Basic MCP Server](01-basic-mcp/):**
3638
- Minimal MCP server supporting both stdio and HTTP, using Gin. Shows server setup, tool registration, and logging/error handling best practices.
37-
- *Key features:* Dual transport (stdio/HTTP), Gin integration, extensible tool registration.
39+
- _Key features:_ Dual transport (stdio/HTTP), Gin integration, extensible tool registration.
3840
- **[02. Basic Token Passthrough](02-basic-token-passthrough/):**
3941
- Transparent authentication token passthrough for HTTP and stdio. Demonstrates context injection and tool development for authenticated requests.
40-
- *Key features:* Token passthrough, context injection, example authenticated tools.
42+
- _Key features:_ Token passthrough, context injection, example authenticated tools.
4143
- **[03. OAuth MCP Server](03-oauth-mcp/):**
4244
- MCP server with OAuth 2.0 protection. Example endpoints for auth, tokens, resource metadata; context-based token handling and authenticated API usage.
43-
- *Key features:* OAuth 2.0 flow, protected endpoints, context-based token propagation, demo tools.
45+
- _Key features:_ OAuth 2.0 flow, protected endpoints, context-based token propagation, demo tools.
4446
- **[04. Observability](04-observability/):**
4547
- Observability and tracing for MCP servers using OpenTelemetry and structured logging. Includes metrics, detailed traces, and error reporting.
46-
- *Key features:* Tracing, structured logging, observability middleware, error reporting.
48+
- _Key features:_ Tracing, structured logging, observability middleware, error reporting.
4749
- **[05. MCP Proxy](05-mcp-proxy/):**
4850
- Proxy server that aggregates multiple MCP servers behind one endpoint. Supports live streaming and centralizes configuration/security.
49-
- *Key features:* Unified access, SSE/HTTP streaming, flexible config, improved security.
51+
- _Key features:_ Unified access, SSE/HTTP streaming, flexible config, improved security.
5052

5153
Refer to each module’s directory and `README.md` for detailed instructions and code examples
5254

@@ -120,7 +122,7 @@ The following diagrams illustrate the OAuth flow within MCP, detailing the seque
120122

121123
![oauth](./images/oauth-flow-01.png)
122124

123-
*Sequence diagram showing communication with each role separately:*
125+
_Sequence diagram showing communication with each role separately:_
124126

125127
![oauth-sequence](./images/oauth-flow-02.png)
126128

0 commit comments

Comments
 (0)