Skip to content

Commit 6b88e39

Browse files
committed
docs: update readme and prepare v0.4.0 release
1 parent b33732b commit 6b88e39

File tree

2 files changed

+23
-9
lines changed

2 files changed

+23
-9
lines changed

CHANGELOG.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,17 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8+
## [0.4.0] - 2025-09-25
9+
10+
### Changed
11+
- Updated README.md documentation to reflect current API signatures
12+
- Fixed outdated method examples in Quick Start and Usage Guide sections
13+
- Updated API Methods Reference table with complete method list
14+
- Corrected all code examples to include `*Response` return values
15+
16+
### Fixed
17+
- Documentation inconsistencies with actual API methods
18+
- Missing methods in API reference table (ListByServerID, ListByUpdatedSince)
819

920
## [0.3.0] - 2025-09-24
1021

@@ -151,6 +162,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
151162
- Memory-efficient handling of large result sets
152163
- Optional automatic pagination for convenience
153164

165+
[0.4.0]: https://github.com/leefowlercu/go-mcp-registry/releases/tag/v0.4.0
154166
[0.3.0]: https://github.com/leefowlercu/go-mcp-registry/releases/tag/v0.3.0
155167
[0.2.0]: https://github.com/leefowlercu/go-mcp-registry/releases/tag/v0.2.0
156168
[0.1.0]: https://github.com/leefowlercu/go-mcp-registry/releases/tag/v0.1.0

README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ func main() {
6060
}
6161

6262
// Get a specific server by name
63-
gmailServers, err := client.Servers.GetByName(ctx, "ai.waystation/gmail")
63+
gmailServers, _, err := client.Servers.ListByName(ctx, "ai.waystation/gmail")
6464
if err != nil {
6565
log.Fatal(err)
6666
}
@@ -108,23 +108,23 @@ opts := &mcp.ServerListOptions{
108108
servers, resp, err := client.Servers.List(ctx, opts)
109109

110110
// Get all servers (handles pagination automatically)
111-
allServers, err := client.Servers.ListAll(ctx, nil)
111+
allServers, _, err := client.Servers.ListAll(ctx, nil)
112112
```
113113

114114
### Getting Servers by Name
115115

116116
```go
117117
// Get all versions of a server
118-
servers, err := client.Servers.GetByName(ctx, "ai.waystation/gmail")
118+
servers, _, err := client.Servers.ListByName(ctx, "ai.waystation/gmail")
119119

120120
// Get latest version only
121-
server, err := client.Servers.GetByNameLatest(ctx, "ai.waystation/gmail")
121+
server, _, err := client.Servers.GetByNameLatest(ctx, "ai.waystation/gmail")
122122

123123
// Get specific version
124-
server, err := client.Servers.GetByNameExactVersion(ctx, "ai.waystation/gmail", "0.3.1")
124+
server, _, err := client.Servers.GetByNameExactVersion(ctx, "ai.waystation/gmail", "0.3.1")
125125

126126
// Get latest active version (uses semantic versioning)
127-
server, err := client.Servers.GetByNameLatestActiveVersion(ctx, "ai.waystation/gmail")
127+
server, _, err := client.Servers.GetByNameLatestActiveVersion(ctx, "ai.waystation/gmail")
128128
```
129129

130130
### Manual Pagination
@@ -184,9 +184,11 @@ if resp.Rate.Limit > 0 {
184184
| Method | Description |
185185
|--------|-------------|
186186
| `List(ctx, opts)` | List servers with pagination and filtering |
187-
| `Get(ctx, id)` | Get server by ID |
187+
| `Get(ctx, serverID, opts)` | Get server by ID with optional version |
188188
| `ListAll(ctx, opts)` | Get all servers (automatic pagination) |
189-
| `GetByName(ctx, name)` | Get all versions of a named server |
189+
| `ListByName(ctx, name)` | Get all versions of a named server |
190+
| `ListByServerID(ctx, serverID)` | Get all versions of a server by server ID |
191+
| `ListByUpdatedSince(ctx, since)` | Get servers updated since timestamp |
190192
| `GetByNameLatest(ctx, name)` | Get latest version using API filter |
191193
| `GetByNameExactVersion(ctx, name, version)` | Get specific version |
192194
| `GetByNameLatestActiveVersion(ctx, name)` | Get latest active version by semver |
@@ -223,7 +225,7 @@ go test -cover ./...
223225
INTEGRATION_TESTS=true go test ./test/integration/
224226

225227
# Specific test
226-
go test -v ./mcp -run TestServersService_GetByName
228+
go test -v ./mcp -run TestServersService_ListByName
227229
```
228230

229231
### Building

0 commit comments

Comments
 (0)