Skip to content

Commit ccdd6b7

Browse files
authored
Merge pull request #92 from IBM/release-planning-cleanup
Update readme and cleanup
2 parents 6be1873 + ea55bc7 commit ccdd6b7

File tree

2 files changed

+70
-16
lines changed

2 files changed

+70
-16
lines changed

README.md

Lines changed: 61 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -782,7 +782,8 @@ Deployment details can be found in the GitHub Pages.
782782

783783
This project supports deployment to [IBM Cloud Code Engine](https://cloud.ibm.com/codeengine) using the **ibmcloud** CLI and the IBM Container Registry.
784784

785-
---
785+
<details>
786+
<summary><strong>☁️ IBM Cloud Code Engine Deployment</strong></summary>
786787

787788
### 🔧 Prerequisites
788789

@@ -848,11 +849,21 @@ make ibmcloud-ce-status
848849
make ibmcloud-ce-logs
849850
```
850851

852+
</details>
853+
851854
---
852855

853856
## API Endpoints
854857

855-
Generate an API Bearer token, and test the various API endpoints:
858+
You can test the API endpoints through curl, or Swagger UI, and check detailed documentation on ReDoc:
859+
860+
* **Swagger UI** → [http://localhost:4444/docs](http://localhost:4444/docs)
861+
* **ReDoc** → [http://localhost:4444/redoc](http://localhost:4444/redoc)
862+
863+
Generate an API Bearer token, and test the various API endpoints.
864+
865+
<details>
866+
<summary><strong>🔐 Authentication & Health Checks</strong></summary>
856867

857868
```bash
858869
# Generate a bearer token using the configured secret key (use the same as your .env)
@@ -867,12 +878,12 @@ curl -s -k -H "Authorization: Bearer $MCPGATEWAY_BEARER_TOKEN" https://localhost
867878
curl -s -k -H "Authorization: Bearer $MCPGATEWAY_BEARER_TOKEN" https://localhost:4444/version | jq
868879
```
869880

870-
You can test the API endpoints through curl, or Swagger UI, and check detailed documentation on ReDoc:
881+
</details>
871882

872-
* **Swagger UI**[http://localhost:4444/docs](http://localhost:4444/docs)
873-
* **ReDoc**[http://localhost:4444/redoc](http://localhost:4444/redoc)
883+
---
874884

875-
### Protocol APIs (MCP)
885+
<details>
886+
<summary><strong>🧱 Protocol APIs (MCP) /protocol</strong></summary>
876887

877888
```bash
878889
# Initialize MCP session
@@ -910,9 +921,12 @@ curl -N -X POST -H "Authorization: Bearer $MCPGATEWAY_BEARER_TOKEN" \
910921
http://localhost:4444/protocol/sampling/createMessage
911922
```
912923

924+
</details>
925+
913926
---
914927

915-
### JSON-RPC Utility Endpoint
928+
<details>
929+
<summary><strong>🧠 JSON-RPC Utility /rpc</strong></summary>
916930

917931
```bash
918932
# Generic JSON-RPC calls (tools, gateways, roots, etc.)
@@ -924,9 +938,13 @@ curl -X POST -H "Authorization: Bearer $MCPGATEWAY_BEARER_TOKEN" \
924938

925939
Handles any method name: `list_tools`, `list_gateways`, `prompts/get`, or invokes a tool if method matches a registered tool name .
926940

941+
</details>
942+
927943
---
928944

929-
### Tool Management (`/tools`)
945+
<details>
946+
<summary><strong>🔧 Tool Management /tools</strong></summary>
947+
930948

931949
```bash
932950
# Register a new tool
@@ -966,9 +984,12 @@ curl -X POST -H "Authorization: Bearer $MCPGATEWAY_BEARER_TOKEN" \
966984
curl -X DELETE -H "Authorization: Bearer $MCPGATEWAY_BEARER_TOKEN" http://localhost:4444/tools/1
967985
```
968986

987+
</details>
988+
969989
---
970990

971-
### Gateway Management (`/gateways`)
991+
<details>
992+
<summary><strong>🌐 Gateway Management /gateways</strong></summary>
972993

973994
```bash
974995
# Register an MCP server as a new gateway provider
@@ -997,9 +1018,13 @@ curl -X POST -H "Authorization: Bearer $MCPGATEWAY_BEARER_TOKEN" \
9971018
curl -X DELETE -H "Authorization: Bearer $MCPGATEWAY_BEARER_TOKEN" http://localhost:4444/gateways/1
9981019
```
9991020

1021+
</details>
1022+
10001023
---
10011024

1002-
### Resource Management (`/resources`)
1025+
<details>
1026+
<summary><strong>📁 Resource Management /resources</strong></summary>
1027+
10031028

10041029
```bash
10051030
# Register resource
@@ -1031,9 +1056,12 @@ curl -X DELETE -H "Authorization: Bearer $MCPGATEWAY_BEARER_TOKEN" http://localh
10311056
curl -N -H "Authorization: Bearer $MCPGATEWAY_BEARER_TOKEN" http://localhost:4444/resources/subscribe/config://app/settings
10321057
```
10331058

1059+
</details>
1060+
10341061
---
10351062

1036-
### Prompt Management (`/prompts`)
1063+
<details>
1064+
<summary><strong>📝 Prompt Management /prompts</strong></summary>
10371065

10381066
```bash
10391067
# Create prompt template
@@ -1076,9 +1104,12 @@ curl -X POST -H "Authorization: Bearer $MCPGATEWAY_BEARER_TOKEN" \
10761104
curl -X DELETE -H "Authorization: Bearer $MCPGATEWAY_BEARER_TOKEN" http://localhost:4444/prompts/greet
10771105
```
10781106

1107+
</details>
1108+
10791109
---
10801110

1081-
### Root Management (`/roots`)
1111+
<details>
1112+
<summary><strong>🌲 Root Management /roots</strong></summary>
10821113

10831114
```bash
10841115
# List roots
@@ -1097,9 +1128,12 @@ curl -X DELETE -H "Authorization: Bearer $MCPGATEWAY_BEARER_TOKEN" http://localh
10971128
curl -N -H "Authorization: Bearer $MCPGATEWAY_BEARER_TOKEN" http://localhost:4444/roots/changes
10981129
```
10991130

1131+
</details>
1132+
11001133
---
11011134

1102-
### Server Management (`/servers`)
1135+
<details>
1136+
<summary><strong>🖥️ Server Management /servers</strong></summary>
11031137

11041138
```bash
11051139
# List servers
@@ -1125,9 +1159,12 @@ curl -X POST -H "Authorization: Bearer $MCPGATEWAY_BEARER_TOKEN" \
11251159
http://localhost:4444/servers/1/toggle?activate=false
11261160
```
11271161

1162+
</details>
1163+
11281164
---
11291165

1130-
### Metrics (`/metrics`)
1166+
<details>
1167+
<summary><strong>📊 Metrics /metrics</strong></summary>
11311168

11321169
```bash
11331170
# Get aggregated metrics
@@ -1138,9 +1175,12 @@ curl -X POST -H "Authorization: Bearer $MCPGATEWAY_BEARER_TOKEN" http://localhos
11381175
curl -X POST -H "Authorization: Bearer $MCPGATEWAY_BEARER_TOKEN" http://localhost:4444/metrics/reset?entity=tool&id=1
11391176
```
11401177

1178+
</details>
1179+
11411180
---
11421181

1143-
### Event Streaming & Health
1182+
<details>
1183+
<summary><strong>📡 Events & Health</strong></summary>
11441184

11451185
```bash
11461186
# SSE: all events
@@ -1156,9 +1196,12 @@ curl http://localhost:4444/health
11561196

11571197
Full Swagger UI at `/docs`.
11581198

1199+
</details>
1200+
11591201
---
11601202

1161-
## Sample Tool
1203+
<details>
1204+
<summary><strong>🛠️ Sample Tool</strong></summary>
11621205

11631206
```bash
11641207
uvicorn sample_tool.clock_tool:app --host 0.0.0.0 --port 9000
@@ -1170,6 +1213,8 @@ curl -X POST -H "Content-Type: application/json" \
11701213
http://localhost:9000/rpc
11711214
```
11721215

1216+
</details>
1217+
11731218
---
11741219

11751220
## Testing

docs/docs/media/press/index.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,15 @@
44
55
## Articles
66

7+
!!! details "IBM MCP Gateway: Revolutionizing GenAI Integration for Startups and Enterprises (Pitangent)"
8+
**Author:** Miltan Chaudhury | **Publication:** Pitangent | **Date:** June 11, 2025
9+
[Read the article](https://pitangent.com/ai-ml-development-services/ibm-mcp-gateway-revolutionizing-genai-integration-for-startups-and-enterprises/)
10+
11+
!!! quote
12+
"IBM's MCP Gateway is more than a bridge—it's a platform for accelerating GenAI transformation with agility and confidence. For startups and enterprises navigating the complex AI tool landscape, this innovation brings a modular, future-proof path to build smarter, scalable, and context-aware applications."
13+
14+
The article breaks down the technical benefits of the MCP Gateway and positions it as a game-changer for reducing integration overhead, improving developer productivity, and democratizing AI access for early-stage companies.
15+
716
!!! details "IBM Introduces MCP Gateway to Simplify GenAI Tool Integration (Analytics India Magazine)"
817
**Author:** Ankush Das | **Publication:** Analytics India Magazine | **Date:** June 10, 2025
918
[Read the article](https://analyticsindiamag.com/ai-news-updates/ibm-introduces-mcp-gateway-to-simplify-genai-tool-integration/)

0 commit comments

Comments
 (0)