Which integrations are available for this server?

Seamlessly integrates with [GitHub](/mcp/servers/integrations/github) API for enhanced README fetching when Maven packages link to GitHub repositories, using optional GitHub tokens for higher API rate limits.

Maven Package README MCP Server

license npm version npm downloads GitHub stars

An MCP (Model Context Protocol) server that enables AI assistants to fetch comprehensive information about Maven packages from Maven Central, including README content, package metadata, and search functionality.

Features

Package README Retrieval: Fetch formatted README content with usage examples from Java/Maven packages hosted on Maven Central
Package Information: Get comprehensive package metadata including dependencies, versions, statistics, and maintainer information
Package Search: Search Maven Central with advanced filtering by artifact type, popularity, and relevance
Smart Caching: Intelligent caching system to optimize API usage and improve response times
GitHub Integration: Seamless integration with GitHub API for enhanced README fetching when packages link to GitHub repositories
Error Handling: Robust error handling with automatic retry logic and fallback strategies

MCP Client Configuration

Add this server to your MCP client configuration:

{ "mcpServers": { "maven-package-readme": { "command": "npx", "args": ["maven-package-readme-mcp-server"], "env": { "GITHUB_TOKEN": "your_github_token_here" } } } }

Note: The GITHUB_TOKEN is optional but recommended for higher API rate limits when fetching README content from GitHub.

Available Tools

get_package_readme

Retrieves comprehensive README content and usage examples for Maven packages.

Parameters:

{ "package_name": "org.springframework:spring-core", "version": "latest", "include_examples": true }

package_name (string, required): Maven package name in groupId:artifactId format
version (string, optional): Specific package version or "latest" (default: "latest")
include_examples (boolean, optional): Include usage examples and code snippets (default: true)

Returns: Formatted README content with installation instructions, usage examples, and API documentation.

get_package_info

Fetches detailed package metadata, dependencies, and statistics from Maven Central.

Parameters:

{ "package_name": "com.google.guava:guava", "include_dependencies": true, "include_dev_dependencies": false }

package_name (string, required): Maven package name
include_dependencies (boolean, optional): Include runtime dependencies (default: true)
include_dev_dependencies (boolean, optional): Include test dependencies (default: false)

Returns: Package metadata including version info, maintainers, license, download stats, and dependency tree.

search_packages

Searches Maven Central for packages with advanced filtering capabilities.

Parameters:

{ "query": "spring boot web", "limit": 20, "quality": 0.8 }

query (string, required): Search terms (package name, description, keywords)
limit (number, optional): Maximum number of results to return (default: 20, max: 250)
quality (number, optional): Minimum quality score filter (0-1)

Returns: List of matching packages with names, descriptions, download counts, and relevance scores.

Error Handling

The server handles common error scenarios gracefully:

Package not found: Returns clear error messages with package name suggestions
Rate limiting: Implements automatic retry with exponential backoff
Network timeouts: Configurable timeout with retry logic
Invalid package names: Validates package name format and provides guidance
GitHub API failures: Fallback strategies when GitHub integration fails