Skip to content

README.md

Latest commit

 

History

History
49 lines (36 loc) · 1.75 KB

README.md

File metadata and controls

49 lines (36 loc) · 1.75 KB

authplane-mcp

Maven Central License

Authplane JWT authentication for servers built on the MCP Java SDK. No Spring required.

Install

<dependency>
  <groupId>ai.authplane.sdk</groupId>
  <artifactId>authplane-mcp</artifactId>
  <version>1.0.0-SNAPSHOT</version>
</dependency>

The MCP Java SDK and jakarta.servlet-api are provided — include them in your application's own dependencies. Requires Java 21+.

Quickstart

AuthplaneMcpSetup setup = AuthplaneMcpSetup.builder()
        .issuer("https://auth.example.com")
        .resource("https://mcp.example.com/mcp")
        .scopes(List.of("tools/query", "tools/write"))
        .build()
        .get();

HttpServletStreamableServerTransportProvider transport =
        HttpServletStreamableServerTransportProvider.builder()
                .mcpEndpoint(setup.mcpPath())
                .securityValidator(setup.adapter())
                .contextExtractor(setup.adapter())
                .build();

McpServer.sync(transport)
        .serverInfo(Implementation.builder("MyServer", "1.0.0").build())
        .tools(/* ... */)
        .build();

setup.registerServlets(servletContext, transport);

Call setup.client().close() on shutdown to clear the token cache.

Documentation

Configuration reference, scope enforcement, PRM behaviour, token revocation, token exchange + URL elicitation, error handling, manual setup, and the full API: User Guide.