You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: validate bug reports against v1.0.0-beta-1 and reorganize
- validate all 10 upstream bug reports against contextforge v1.0.0-beta-1
- rename bug report files with contextforge-xxx prefix for clarity
- add 4 new bug reports (007-010) discovered during validation
- update contextforge-002 status to partially fixed (empty string still accepted)
- update contextforge-006 test to expect 422 (fastapi standard behavior)
- add compatibility section to readme noting v1.0.0-beta-1 support
- remove redundant documentation files
- update all file references in tests and readme
Copy file name to clipboardExpand all lines: README.md
+11-6Lines changed: 11 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,6 +8,7 @@ A Go SDK for the [IBM ContextForge MCP Gateway](https://github.com/IBM/mcp-conte
8
8
## Table of Contents
9
9
10
10
-[Overview](#overview)
11
+
-[Compatibility](#compatibility)
11
12
-[Installation](#installation)
12
13
-[Quick Start](#quick-start)
13
14
-[Usage Guide](#usage-guide)
@@ -72,6 +73,10 @@ The SDK provides full management of A2A agents including creation, configuration
72
73
73
74
For more information about the A2A protocol, see the [official specification](https://a2a-protocol.org/latest/specification/) and [project website](https://a2aprotocol.ai/).
74
75
76
+
### Compatibility
77
+
78
+
This SDK is tested against **ContextForge v1.0.0-BETA-1** (PyPI: `mcpgateway==1.0.0b1`).
79
+
75
80
## Installation
76
81
77
82
```bash
@@ -1185,22 +1190,22 @@ This SDK follows the service-oriented architecture pattern established by [googl
1185
1190
The SDK integration tests have identified six bugs in ContextForge (confirmed in both v0.8.0 and v1.0.0-BETA-1). These bugs are in the upstream API, not the SDK implementation. Affected tests are skipped and will be re-enabled once upstream bugs are fixed.
1186
1191
1187
1192
**CONTEXTFORGE-001: Toggle Endpoints Return Stale State**
1188
-
The `POST /prompts/{id}/toggle` and `POST /resources/{id}/toggle` endpoints return stale `isActive` state despite correctly updating the database. See [`docs/upstream-bugs/prompt-toggle.md`](docs/upstream-bugs/prompt-toggle.md).
1193
+
The `POST /prompts/{id}/toggle` and `POST /resources/{id}/toggle` endpoints return stale `isActive` state despite correctly updating the database. See [`docs/upstream-bugs/contextforge-001-prompt-toggle.md`](docs/upstream-bugs/contextforge-001-prompt-toggle.md).
1189
1194
1190
1195
**CONTEXTFORGE-002: Prompts API Accepts Empty Template Field**
1191
-
The `POST /prompts` endpoint accepts prompt creation without the `template` field, allowing semantically invalid prompts. See [`docs/upstream-bugs/prompt-validation-missing-template.md`](docs/upstream-bugs/prompt-validation-missing-template.md).
1196
+
The `POST /prompts` endpoint accepts prompt creation without the `template` field, allowing semantically invalid prompts. See [`docs/upstream-bugs/contextforge-002-prompt-validation-missing-template.md`](docs/upstream-bugs/contextforge-002-prompt-validation-missing-template.md).
1192
1197
1193
1198
**CONTEXTFORGE-003: Prompts Toggle Returns 400 Instead of 404**
1194
-
The `POST /prompts/{id}/toggle` endpoint returns HTTP 400 for non-existent prompts instead of 404. See [`docs/upstream-bugs/prompt-toggle-error-code.md`](docs/upstream-bugs/prompt-toggle-error-code.md).
1199
+
The `POST /prompts/{id}/toggle` endpoint returns HTTP 400 for non-existent prompts instead of 404. See [`docs/upstream-bugs/contextforge-003-prompt-toggle-error-code.md`](docs/upstream-bugs/contextforge-003-prompt-toggle-error-code.md).
1195
1200
1196
1201
**CONTEXTFORGE-004: Teams Individual Resource Endpoints Reject Valid Authentication**
1197
-
Individual team endpoints (`GET/PUT/DELETE /teams/{id}/*`) reject valid JWT tokens with 401 Unauthorized, despite list/create working correctly. See [`docs/upstream-bugs/teams-auth-individual-endpoints.md`](docs/upstream-bugs/teams-auth-individual-endpoints.md).
1202
+
Individual team endpoints (`GET/PUT/DELETE /teams/{id}/*`) reject valid JWT tokens with 401 Unauthorized, despite list/create working correctly. See [`docs/upstream-bugs/contextforge-004-teams-auth-individual-endpoints.md`](docs/upstream-bugs/contextforge-004-teams-auth-individual-endpoints.md).
1198
1203
1199
1204
**CONTEXTFORGE-005: Teams API Ignores User-Provided Slug Field**
1200
-
The `POST /teams` endpoint ignores the `slug` field and always auto-generates from team name. See [`docs/upstream-bugs/teams-slug-ignored.md`](docs/upstream-bugs/teams-slug-ignored.md).
1205
+
The `POST /teams` endpoint ignores the `slug` field and always auto-generates from team name. See [`docs/upstream-bugs/contextforge-005-teams-slug-ignored.md`](docs/upstream-bugs/contextforge-005-teams-slug-ignored.md).
1201
1206
1202
1207
**CONTEXTFORGE-006: Teams API Returns 422 Instead of 400 for Validation Errors**
1203
-
The `POST /teams` endpoint returns HTTP 422 (Unprocessable Entity) for validation errors instead of 400 (Bad Request). See [`docs/upstream-bugs/teams-validation-error-code.md`](docs/upstream-bugs/teams-validation-error-code.md).
1208
+
The `POST /teams` endpoint returns HTTP 422 (Unprocessable Entity) for validation errors instead of 400 (Bad Request). See [`docs/upstream-bugs/contextforge-006-teams-validation-error-code.md`](docs/upstream-bugs/contextforge-006-teams-validation-error-code.md).
1204
1209
1205
1210
All bug reports include root cause analysis, proposed solutions, and workarounds.
t.Skip("Skipping due to upstream ContextForge API bug - toggle returns stale isActive state. See docs/upstream-bugs/prompt-toggle.md")
315
+
t.Skip("Skipping due to upstream ContextForge API bug - toggle returns stale isActive state. See docs/upstream-bugs/contextforge-001-prompt-toggle.md")
0 commit comments