Skip to content

Commit 89422b9

Browse files
committed
README: mention that this project targets Spring AI 1.1.x, polish
Signed-off-by: Daniel Garnier-Moiroux <[email protected]>
1 parent df6cc4d commit 89422b9

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55

66
Security and Authorization support for Model Context Protocol in Spring AI.
77

8+
> ⚠️ This project only works Spring AI's 1.1.x branch.
9+
810
## Table of Contents
911

1012
- [Overview](#overview)
@@ -258,16 +260,18 @@ class McpServerConfiguration {
258260
// OPTIONAL: name of the header containing the API key.
259261
// Here for example, api keys will be sent with "CUSTOM-API-KEY: <value>"
260262
// Replaces .authenticationConverter(...) (see below)
261-
apiKey.headerName("CUSTOM-API-KEY");
263+
//
264+
// apiKey.headerName("CUSTOM-API-KEY");
262265

263266
// OPTIONAL: custom converter for transforming an http request
264267
// into an authentication object. Useful when the header is
265268
// "Authorization: Bearer <value>".
266269
// Replaces .headerName(...) (see above)
267-
apiKey.authenticationConverter(request -> {
268-
var key = extractKey(request);
269-
return ApiKeyAuthenticationToken.unauthenticated(key);
270-
});
270+
//
271+
// apiKey.authenticationConverter(request -> {
272+
// var key = extractKey(request);
273+
// return ApiKeyAuthenticationToken.unauthenticated(key);
274+
// });
271275
}
272276
)
273277
.build();
@@ -292,7 +296,7 @@ class McpServerConfiguration {
292296
}
293297
```
294298

295-
Then you should be able to call your MCP server with `X-API-key: api01.mycustomapikey`.
299+
Then you should be able to call your MCP server with a header `X-API-key: api01.mycustomapikey`.
296300

297301
### Known limitations
298302

@@ -738,4 +742,4 @@ This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENS
738742

739743
---
740744

741-
**Note:** This is a community-driven project and is not officially endorsed by Spring AI or the MCP project.
745+
**Note:** This is a community-driven project and is not officially endorsed by Spring AI or the MCP project.

0 commit comments

Comments
 (0)