Index
All Classes and Interfaces|All Packages|Constant Field Values
A
- ACCESS_TOKEN - Static variable in class eu.mrapik.minecraftservermcp.mcp.TransportContextKeys
-
Raw token string from the request.
- allowsCommand(String) - Method in class eu.mrapik.minecraftservermcp.config.CommandPolicy
-
Whether the command line is allowed given whitelist/blacklist rules on the root command name.
- allowsPath(String) - Method in class eu.mrapik.minecraftservermcp.config.FilesystemPolicy
-
Evaluates folder and file rules in order: folder whitelist, folder blacklist, file whitelist, file blacklist.
- api() - Method in class eu.mrapik.minecraftservermcp.mcp.McpHttpServer
-
Public API for registering tools (same instance plugins receive from the service manager).
B
- bindAddress() - Method in class eu.mrapik.minecraftservermcp.config.PluginSettings
-
Address Jetty binds to for MCP HTTP.
- blockingIo() - Static method in class eu.mrapik.minecraftservermcp.internal.McpSchedulers
-
Shared scheduler for blocking filesystem operations off the main thread.
- bool(Map<String, Object>, String, boolean) - Static method in class eu.mrapik.minecraftservermcp.util.ToolArguments
-
Reads a boolean argument; accepts Boolean or parses string values with
Boolean.parseBoolean(String). - BuiltinMcpResources - Class in eu.mrapik.minecraftservermcp.builtin.resources
-
Registers built-in MCP resources and URI templates for filesystem read/list and player snapshots.
- BuiltinResourceUris - Class in eu.mrapik.minecraftservermcp.builtin.resources
-
Canonical URIs for built-in MCP resources.
- BuiltinToolCatalog - Class in eu.mrapik.minecraftservermcp.builtin
-
Central list of built-in
McpToolDefinitions. - BuiltinToolContext - Record Class in eu.mrapik.minecraftservermcp.builtin
-
Dependencies shared by built-in tool handlers: the MCP plugin,
ServerFilePaths, and a livePluginSettingssupplier. - BuiltinToolContext(JavaPlugin, ServerFilePaths, Supplier<PluginSettings>) - Constructor for record class eu.mrapik.minecraftservermcp.builtin.BuiltinToolContext
-
Creates an instance of a
BuiltinToolContextrecord class. - BuiltinToolIds - Class in eu.mrapik.minecraftservermcp.builtin
-
String constants for built-in MCP surface area.
- BuiltinTools - Class in eu.mrapik.minecraftservermcp.builtin
-
Factory for
McpToolDefinitioninstances used by built-in tool classes (*ToolSpec). - BukkitAccess - Interface in eu.mrapik.minecraftservermcp.internal
-
Narrow view of
Bukkitservices used during MCP plugin lifecycle.
C
- call(McpToolInvocation) - Method in interface eu.mrapik.minecraftservermcp.api.McpToolDefinition
-
Handles a single
tools/callafter authentication and per-token policy checks. - commandBlacklist() - Method in record class eu.mrapik.minecraftservermcp.config.ToolAccessConfig
-
Optional console command deny list (root command names).
- CommandPolicy - Class in eu.mrapik.minecraftservermcp.config
-
Restricts console commands using
ToolAccessConfig.commandWhitelist()andToolAccessConfig.commandBlacklist(). - CommandPolicy(List<String>, List<String>) - Constructor for class eu.mrapik.minecraftservermcp.config.CommandPolicy
-
Creates a policy; list entries are trimmed and lowercased for matching.
- commandRoot(String) - Static method in class eu.mrapik.minecraftservermcp.config.CommandPolicy
-
First word of the command, lowercased, without a leading
/. - commandWhitelist() - Method in record class eu.mrapik.minecraftservermcp.config.ToolAccessConfig
-
Optional console command allow list (root command names).
- create(Server, SslSettings, String) - Static method in class eu.mrapik.minecraftservermcp.mcp.JettySslConnector
-
Creates a TLS
ServerConnectorfor HTTPS using the keystore and port fromssl.
D
- define(BuiltinToolContext, McpJsonMapper, String, String, String, BiFunction<McpToolInvocation, BuiltinToolContext, Mono<McpSchema.CallToolResult>>) - Static method in class eu.mrapik.minecraftservermcp.builtin.BuiltinTools
-
Creates a definition with the given MCP name, description, JSON Schema string for inputs, and handler.
- definition(BuiltinToolContext, McpJsonMapper) - Static method in class eu.mrapik.minecraftservermcp.builtin.command.ServerCommandToolSpec
-
Builds the
server_commandtool definition for registration on the MCP server. - definition(BuiltinToolContext, McpJsonMapper) - Static method in class eu.mrapik.minecraftservermcp.builtin.filesystem.FsWriteToolSpec
-
Builds the
fs_writetool definition for registration on the MCP server. - definition(BuiltinToolContext, McpJsonMapper) - Static method in class eu.mrapik.minecraftservermcp.builtin.logs.ServerLogsToolSpec
-
Builds the
server_logstool definition for registration on the MCP server. - definitions(JavaPlugin, Supplier<PluginSettings>, ServerFilePaths) - Static method in class eu.mrapik.minecraftservermcp.builtin.BuiltinToolCatalog
-
Builds the full set of built-in tool definitions for registration on the MCP server.
- disabled() - Static method in class eu.mrapik.minecraftservermcp.config.SslSettings
-
Returns settings with
SslSettings.enabled()false(no connector created).
E
- enabled() - Method in class eu.mrapik.minecraftservermcp.config.SslSettings
-
Whether the MCP plugin should open an HTTPS connector.
- enabled() - Method in record class eu.mrapik.minecraftservermcp.config.ToolAccessConfig
-
Global enable flag for this tool under the profile.
- envelopeErr(String) - Static method in class eu.mrapik.minecraftservermcp.util.ToolResults
-
JSON string for an error envelope.
- envelopeOk(Object) - Static method in class eu.mrapik.minecraftservermcp.util.ToolResults
-
JSON string for a successful envelope (e.g.
- equals(Object) - Method in record class eu.mrapik.minecraftservermcp.builtin.BuiltinToolContext
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class eu.mrapik.minecraftservermcp.config.TokenAccessProfile
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class eu.mrapik.minecraftservermcp.config.ToolAccessConfig
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class eu.mrapik.minecraftservermcp.fs.ServerFilePaths
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class eu.mrapik.minecraftservermcp.internal.McpToolInvocationImpl
-
Indicates whether some other object is "equal to" this one.
- err(String) - Static method in class eu.mrapik.minecraftservermcp.util.ToolResults
-
Error tool result: JSON text body with
isError(true). - eu.mrapik.minecraftservermcp - package eu.mrapik.minecraftservermcp
- eu.mrapik.minecraftservermcp.api - package eu.mrapik.minecraftservermcp.api
- eu.mrapik.minecraftservermcp.builtin - package eu.mrapik.minecraftservermcp.builtin
- eu.mrapik.minecraftservermcp.builtin.command - package eu.mrapik.minecraftservermcp.builtin.command
- eu.mrapik.minecraftservermcp.builtin.filesystem - package eu.mrapik.minecraftservermcp.builtin.filesystem
- eu.mrapik.minecraftservermcp.builtin.logs - package eu.mrapik.minecraftservermcp.builtin.logs
- eu.mrapik.minecraftservermcp.builtin.player - package eu.mrapik.minecraftservermcp.builtin.player
- eu.mrapik.minecraftservermcp.builtin.resources - package eu.mrapik.minecraftservermcp.builtin.resources
- eu.mrapik.minecraftservermcp.command - package eu.mrapik.minecraftservermcp.command
- eu.mrapik.minecraftservermcp.config - package eu.mrapik.minecraftservermcp.config
- eu.mrapik.minecraftservermcp.fs - package eu.mrapik.minecraftservermcp.fs
- eu.mrapik.minecraftservermcp.internal - package eu.mrapik.minecraftservermcp.internal
- eu.mrapik.minecraftservermcp.mcp - package eu.mrapik.minecraftservermcp.mcp
- eu.mrapik.minecraftservermcp.security - package eu.mrapik.minecraftservermcp.security
- eu.mrapik.minecraftservermcp.util - package eu.mrapik.minecraftservermcp.util
- exchange() - Method in interface eu.mrapik.minecraftservermcp.api.McpToolInvocation
-
MCP session exchange (transport, session state).
- exchange() - Method in record class eu.mrapik.minecraftservermcp.internal.McpToolInvocationImpl
-
Returns the value of the
exchangerecord component. - extra() - Method in record class eu.mrapik.minecraftservermcp.config.ToolAccessConfig
-
Custom configuration entries not mapped to built-in fields.
- extractToken(HttpServletRequest) - Static method in class eu.mrapik.minecraftservermcp.security.HttpTokenSupport
-
Bearer wins if present and non-blank; otherwise the dedicated MCP header.
- extractTokenFromHeaderMap(Map<String, List<String>>) - Static method in class eu.mrapik.minecraftservermcp.security.HttpTokenSupport
-
Same precedence as
HttpTokenSupport.extractToken(HttpServletRequest)for the header map used by streamable HTTP validation.
F
- fileBlacklist() - Method in record class eu.mrapik.minecraftservermcp.config.ToolAccessConfig
-
Optional file path deny list for filesystem tools.
- FilesystemPolicy - Class in eu.mrapik.minecraftservermcp.config
-
Evaluates whether a path relative to the server root is allowed by
ToolAccessConfigfile/folder lists. - FilesystemPolicy(List<String>, List<String>, List<String>, List<String>) - Constructor for class eu.mrapik.minecraftservermcp.config.FilesystemPolicy
-
Internal constructor after optional list normalization.
- fileWhitelist() - Method in record class eu.mrapik.minecraftservermcp.config.ToolAccessConfig
-
Optional file path allow list for filesystem tools.
- folderBlacklist() - Method in record class eu.mrapik.minecraftservermcp.config.ToolAccessConfig
-
Optional folder prefix deny list for filesystem tools.
- folderWhitelist() - Method in record class eu.mrapik.minecraftservermcp.config.ToolAccessConfig
-
Optional folder prefix allow list for filesystem tools.
- fromSection(ConfigurationSection) - Static method in record class eu.mrapik.minecraftservermcp.config.ToolAccessConfig
-
Parses a configuration section.
- fromToolConfig(ToolAccessConfig) - Static method in class eu.mrapik.minecraftservermcp.config.CommandPolicy
-
Builds a policy from command whitelist/blacklist fields in
cfg. - fromToolConfig(ToolAccessConfig) - Static method in class eu.mrapik.minecraftservermcp.config.FilesystemPolicy
-
Builds a policy from the file-related fields of a tool config.
- FS_LIST - Static variable in class eu.mrapik.minecraftservermcp.builtin.BuiltinToolIds
-
MCP resource: list directory.
- FS_LIST_TEMPLATE - Static variable in class eu.mrapik.minecraftservermcp.builtin.resources.BuiltinResourceUris
-
Template for listing a directory; policy id
BuiltinToolIds.FS_LIST. - FS_READ - Static variable in class eu.mrapik.minecraftservermcp.builtin.BuiltinToolIds
-
MCP resource: read file (UTF-8).
- FS_READ_TEMPLATE - Static variable in class eu.mrapik.minecraftservermcp.builtin.resources.BuiltinResourceUris
-
RFC 6570-style template for reading a file; policy id
BuiltinToolIds.FS_READ. - FS_WRITE - Static variable in class eu.mrapik.minecraftservermcp.builtin.BuiltinToolIds
-
Write or append file bytes (Base64).
- FsWriteToolSpec - Class in eu.mrapik.minecraftservermcp.builtin.filesystem
-
MCP tool that writes or appends raw bytes to a path under the server root.
H
- hashCode() - Method in record class eu.mrapik.minecraftservermcp.builtin.BuiltinToolContext
-
Returns a hash code value for this object.
- hashCode() - Method in record class eu.mrapik.minecraftservermcp.config.TokenAccessProfile
-
Returns a hash code value for this object.
- hashCode() - Method in record class eu.mrapik.minecraftservermcp.config.ToolAccessConfig
-
Returns a hash code value for this object.
- hashCode() - Method in record class eu.mrapik.minecraftservermcp.fs.ServerFilePaths
-
Returns a hash code value for this object.
- hashCode() - Method in record class eu.mrapik.minecraftservermcp.internal.McpToolInvocationImpl
-
Returns a hash code value for this object.
- HEADER_AUTHORIZATION - Static variable in class eu.mrapik.minecraftservermcp.security.HttpTokenSupport
-
HTTP header name for
Authorization(Bearer token). - HEADER_MCP_TOKEN - Static variable in class eu.mrapik.minecraftservermcp.security.HttpTokenSupport
-
HTTP header name for a raw token when not using Bearer.
- HttpTokenSupport - Class in eu.mrapik.minecraftservermcp.security
-
Extracts the MCP access token from HTTP requests in two supported shapes:
Authorization: Bearer <token>HttpTokenSupport.HEADER_MCP_TOKEN: <token> (plain header value) The servlet variant readsHttpServletRequestheaders; the map variant supports the MCP transport's header map during the security validation callback (header names matched case-insensitively).
I
- id() - Method in interface eu.mrapik.minecraftservermcp.api.McpToolDefinition
-
Unique MCP tool name.
- ID - Static variable in class eu.mrapik.minecraftservermcp.builtin.command.ServerCommandToolSpec
-
MCP tool name and config key ("server_command").
- ID - Static variable in class eu.mrapik.minecraftservermcp.builtin.filesystem.FsWriteToolSpec
-
MCP tool name and config key ("fs_write").
- ID - Static variable in class eu.mrapik.minecraftservermcp.builtin.logs.ServerLogsToolSpec
-
MCP tool name and config key ("server_logs").
- intArg(Map<String, Object>, String, int) - Static method in class eu.mrapik.minecraftservermcp.util.ToolArguments
-
Reads a non-negative int from
args(tool arguments orToolAccessConfig.extra()).
J
- JettySslConnector - Class in eu.mrapik.minecraftservermcp.mcp
-
Builds a
ServerConnectorfor HTTPS using a keystore fromSslSettings.
K
- keyPassword() - Method in class eu.mrapik.minecraftservermcp.config.SslSettings
-
Key password when it differs from the keystore password; may be null to use the keystore password.
- keystorePassword() - Method in class eu.mrapik.minecraftservermcp.config.SslSettings
-
Password for the keystore file.
- keystorePath() - Method in class eu.mrapik.minecraftservermcp.config.SslSettings
-
Absolute path to the keystore file (JKS or PKCS12).
- keystoreType() - Method in class eu.mrapik.minecraftservermcp.config.SslSettings
-
Java
KeyStoretype (e.g.
L
- load(JavaPlugin) - Static method in class eu.mrapik.minecraftservermcp.config.PluginSettings
-
Reads top-level keys (
bindAddress,port,mcpPath,maxReadBytes) and theaccesstree. - load(JavaPlugin, FileConfiguration, int) - Static method in class eu.mrapik.minecraftservermcp.config.SslSettings
-
Parses the
sslsection. - LogFileTail - Class in eu.mrapik.minecraftservermcp.util
-
Reads the tail of a UTF-8 text file without loading the whole file into memory.
M
- map(McpSchema.CallToolRequest) - Static method in class eu.mrapik.minecraftservermcp.util.ToolArguments
-
Returns the argument map from the request, never null.
- map(Player) - Static method in class eu.mrapik.minecraftservermcp.builtin.player.PlayerSnapshots
-
Flat map suitable for Jackson; keys use camelCase consistent with JSON conventions.
- maxReadBytes() - Method in class eu.mrapik.minecraftservermcp.config.PluginSettings
-
Maximum number of bytes
fs_readmay return for one call (global cap; profiles can still tighten paths). - McpCommand - Class in eu.mrapik.minecraftservermcp.command
-
In-game admin command: reload
config.ymlwithout restarting the server or dropping MCP tools. - McpCommand() - Constructor for class eu.mrapik.minecraftservermcp.command.McpCommand
- McpHttpServer - Class in eu.mrapik.minecraftservermcp.mcp
-
Embeds Jetty and the MCP SDK's streamable HTTP servlet so clients connect to
http://host:portplus the configured servlet path (seePluginSettings.mcpPath()). - McpHttpServer(JavaPlugin, AtomicReference<PluginSettings>, ServerFilePaths) - Constructor for class eu.mrapik.minecraftservermcp.mcp.McpHttpServer
-
Wires Jetty, MCP transport,
MinecraftServerMcpImpl, and registersbuilt-in tools. - mcpPath() - Method in class eu.mrapik.minecraftservermcp.config.PluginSettings
-
Servlet path for the MCP endpoint (always starts with
/). - mcpPlugin() - Method in interface eu.mrapik.minecraftservermcp.api.McpToolInvocation
-
The MinecraftServerMCP plugin instance (scheduler, data folder, logger).
- mcpPlugin() - Method in record class eu.mrapik.minecraftservermcp.builtin.BuiltinToolContext
-
Returns the value of the
mcpPluginrecord component. - mcpPlugin() - Method in record class eu.mrapik.minecraftservermcp.internal.McpToolInvocationImpl
-
Returns the value of the
mcpPluginrecord component. - McpSchedulers - Class in eu.mrapik.minecraftservermcp.internal
-
Shared Reactor
Schedulerfor blocking file I/O used by filesystem tools, so work stays off the game thread without unbounded thread creation. - mcpServer() - Method in interface eu.mrapik.minecraftservermcp.api.MinecraftServerMcp
-
Direct access to the underlying Model Context Protocol async server.
- mcpServer() - Method in class eu.mrapik.minecraftservermcp.internal.MinecraftServerMcpImpl
- mcpServer() - Method in class eu.mrapik.minecraftservermcp.mcp.McpHttpServer
-
Exposes the underlying MCP async server (same instance passed to
MinecraftServerMcpImpl). - McpToolDefinition - Interface in eu.mrapik.minecraftservermcp.api
-
Describes one MCP tool: a stable id, the metadata clients see in
tools/list, and an asynchronous handler fortools/call. - McpToolInvocation - Interface in eu.mrapik.minecraftservermcp.api
-
Everything a tool handler needs for one
tools/call: the raw MCP request, the authenticated access profile, and the effective policy for this tool id. - McpToolInvocationImpl - Record Class in eu.mrapik.minecraftservermcp.internal
-
Immutable record holding all fields for
McpToolInvocation; constructed byToolInvocationGateafter the token and tool policy have been validated. - McpToolInvocationImpl(McpAsyncServerExchange, McpSchema.CallToolRequest, TokenAccessProfile, ToolAccessConfig, JavaPlugin, ServerFilePaths, PluginSettings) - Constructor for record class eu.mrapik.minecraftservermcp.internal.McpToolInvocationImpl
-
Creates an instance of a
McpToolInvocationImplrecord class. - MinecraftServerMcp - Interface in eu.mrapik.minecraftservermcp.api
-
Public extension point for registering MCP tools from other Bukkit plugins.
- MinecraftServerMCP - Class in eu.mrapik.minecraftservermcp
-
Spigot plugin entry point: setups the bootstrap class
- MinecraftServerMCP() - Constructor for class eu.mrapik.minecraftservermcp.MinecraftServerMCP
- MinecraftServerMcpImpl - Class in eu.mrapik.minecraftservermcp.internal
-
Service implementation registered under
MinecraftServerMcp: tools are added throughToolInvocationGate, while built-in resources are registered separately inMcpHttpServerusingResourceInvocationGate. - MinecraftServerMcpImpl(JavaPlugin, AtomicReference<PluginSettings>, ServerFilePaths, McpAsyncServer) - Constructor for class eu.mrapik.minecraftservermcp.internal.MinecraftServerMcpImpl
-
Creates the service implementation registered under
MinecraftServerMcp. - MinecraftServerMcpPluginBootstrap - Class in eu.mrapik.minecraftservermcp.internal
-
Bootstrap class; Loads
config.yml, starts the embedded MCP HTTP (and optional HTTPS) server, and registersMinecraftServerMcpin the BukkitServicesManager. - MinecraftServerMcpPluginBootstrap(BukkitAccess) - Constructor for class eu.mrapik.minecraftservermcp.internal.MinecraftServerMcpPluginBootstrap
-
Constructor parameters are passed by the plugin's main class to avoid a direct dependency on the plugin class itself,
N
- normalizeSlashes(String) - Static method in class eu.mrapik.minecraftservermcp.config.PathNorm
-
Normalizes separators for cross-platform config comparisons.
O
- ok(Object) - Static method in class eu.mrapik.minecraftservermcp.util.ToolResults
-
Successful tool result: JSON text body with
isError(false). - onCommand(CommandSender, Command, String, String[]) - Method in class eu.mrapik.minecraftservermcp.command.McpCommand
- onDisable() - Method in class eu.mrapik.minecraftservermcp.MinecraftServerMCP
-
Delegates to
MinecraftServerMcpPluginBootstrap.onDisable(JavaPlugin). - onDisable(JavaPlugin) - Method in class eu.mrapik.minecraftservermcp.internal.MinecraftServerMcpPluginBootstrap
-
Shutdown logic: unregisters services and stops the MCP/Jetty stack.
- onEnable() - Method in class eu.mrapik.minecraftservermcp.MinecraftServerMCP
-
Delegates to
MinecraftServerMcpPluginBootstrap.onEnable(JavaPlugin). - onEnable(JavaPlugin) - Method in class eu.mrapik.minecraftservermcp.internal.MinecraftServerMcpPluginBootstrap
-
Startup logic: loads configuration, starts the MCP/Jetty stack, and registers services and commands.
- onTabComplete(CommandSender, Command, String, String[]) - Method in class eu.mrapik.minecraftservermcp.command.McpCommand
- owningPlugin() - Method in interface eu.mrapik.minecraftservermcp.api.McpToolDefinition
-
Plugin that owns this tool registration (logging, lifecycle).
P
- PathNorm - Class in eu.mrapik.minecraftservermcp.config
-
Normalizes user-provided path fragments so comparisons use forward slashes regardless of OS separator.
- paths() - Method in record class eu.mrapik.minecraftservermcp.builtin.BuiltinToolContext
-
Returns the value of the
pathsrecord component. - PERMISSION_RELOAD - Static variable in class eu.mrapik.minecraftservermcp.command.McpCommand
-
Permission required for "reload".
- permissiveDefault() - Static method in record class eu.mrapik.minecraftservermcp.config.ToolAccessConfig
-
Used when a profile defines no
tools.<id>section: tool allowed, lists unset (no restriction from lists). - PLAYER_GET - Static variable in class eu.mrapik.minecraftservermcp.builtin.BuiltinToolIds
-
MCP resource: one online player JSON.
- PLAYER_GET_TEMPLATE - Static variable in class eu.mrapik.minecraftservermcp.builtin.resources.BuiltinResourceUris
-
Template for one player's snapshot; policy id
BuiltinToolIds.PLAYER_GET. - PLAYERS_LIST - Static variable in class eu.mrapik.minecraftservermcp.builtin.BuiltinToolIds
-
MCP resource: online players JSON.
- PLAYERS_LIST_URI - Static variable in class eu.mrapik.minecraftservermcp.builtin.resources.BuiltinResourceUris
-
Fixed URI for the online-player list; policy id
BuiltinToolIds.PLAYERS_LIST. - PlayerSnapshots - Class in eu.mrapik.minecraftservermcp.builtin.player
-
Serializes live
Playerdata into ordered maps and JSON strings for theplayers_listandplayer_getMCP resources. - pluginManager() - Method in interface eu.mrapik.minecraftservermcp.internal.BukkitAccess
-
Returns the plugin manager, used for registering listeners and commands.
- pluginManager() - Method in class eu.mrapik.minecraftservermcp.internal.SpigotBukkitAccess
- pluginSettings() - Method in interface eu.mrapik.minecraftservermcp.api.McpToolInvocation
-
Snapshot of global plugin settings (bind address, port,
PluginSettings.maxReadBytes(), etc.). - pluginSettings() - Method in record class eu.mrapik.minecraftservermcp.internal.McpToolInvocationImpl
-
Returns the value of the
pluginSettingsrecord component. - PluginSettings - Class in eu.mrapik.minecraftservermcp.config
-
Immutable snapshot of the MCP plugin's
config.yml: HTTP listen options, global limits, and the mapping from secret tokens toaccess profiles. - port() - Method in class eu.mrapik.minecraftservermcp.config.PluginSettings
-
TCP listen port for MCP HTTP.
- port() - Method in class eu.mrapik.minecraftservermcp.config.SslSettings
-
TLS listen port (separate from
PluginSettings.port()). - profile() - Method in interface eu.mrapik.minecraftservermcp.api.McpToolInvocation
-
Access profile tied to the token used on this connection (from
config.ymlaccess.*). - profile() - Method in record class eu.mrapik.minecraftservermcp.internal.McpToolInvocationImpl
-
Returns the value of the
profilerecord component. - profileByToken(String) - Method in class eu.mrapik.minecraftservermcp.config.PluginSettings
-
Looks up the profile for a token string exactly as sent in the
AuthorizationorX-MCP-Tokenheader. - profileName() - Method in record class eu.mrapik.minecraftservermcp.config.TokenAccessProfile
-
Config section name, e.g.
Q
- queryParam(URI, String) - Static method in class eu.mrapik.minecraftservermcp.builtin.resources.BuiltinResourceUris
-
Reads one query parameter from a hierarchical URI (e.g.
R
- read(McpAsyncServerExchange, McpSchema.ReadResourceRequest, ToolAccessConfig, JavaPlugin, ServerFilePaths) - Method in interface eu.mrapik.minecraftservermcp.internal.ResourceInvocationGate.ResourceHandler
-
Produces the MCP read result for an authorized request.
- readTail(Path, int, int) - Static method in class eu.mrapik.minecraftservermcp.util.LogFileTail
-
Reads at most
maxBytesfrom the end of the file, then keeps at mostmaxLineslines (counting newlines). - registerAll(McpAsyncServer, JavaPlugin, AtomicReference<PluginSettings>, ServerFilePaths, BuiltinToolContext) - Static method in class eu.mrapik.minecraftservermcp.builtin.resources.BuiltinMcpResources
-
Adds all built-in resources to the MCP server (blocking until registration completes).
- registerTool(McpToolDefinition) - Method in interface eu.mrapik.minecraftservermcp.api.MinecraftServerMcp
-
Adds a tool to the MCP server, or replaces an existing tool with the same MCP tool name.
- registerTool(McpToolDefinition) - Method in class eu.mrapik.minecraftservermcp.internal.MinecraftServerMcpImpl
- relativeToRoot(Path) - Method in record class eu.mrapik.minecraftservermcp.fs.ServerFilePaths
-
Computes a forward-slash path relative to the server root for policy checks and messages.
- RELOAD_COMMAND - Static variable in class eu.mrapik.minecraftservermcp.command.McpCommand
-
Subcommand name for
MinecraftServerMcp.reloadConfiguration(). - reloadConfiguration() - Method in interface eu.mrapik.minecraftservermcp.api.MinecraftServerMcp
-
Reloads this plugin's
config.ymlfrom disk and replaces the in-memoryPluginSettings. - reloadConfiguration() - Method in class eu.mrapik.minecraftservermcp.internal.MinecraftServerMcpImpl
- request() - Method in interface eu.mrapik.minecraftservermcp.api.McpToolInvocation
-
The tool call request, including the
argumentsmap parsed from JSON. - request() - Method in record class eu.mrapik.minecraftservermcp.internal.McpToolInvocationImpl
-
Returns the value of the
requestrecord component. - resolveChecked(String) - Method in record class eu.mrapik.minecraftservermcp.fs.ServerFilePaths
-
Resolves a path relative to the server root and ensures it stays inside that directory.
- ResourceInvocationGate - Class in eu.mrapik.minecraftservermcp.internal
-
Applies the same bearer-token and
ToolAccessConfigchecks asToolInvocationGate, but for MCPresources/readrequests. - ResourceInvocationGate.ResourceHandler - Interface in eu.mrapik.minecraftservermcp.internal
-
Callback executed after
ResourceInvocationGatehas resolved the token profile and confirmed that the policy id is enabled. - runSync(Callable<McpSchema.CallToolResult>) - Method in record class eu.mrapik.minecraftservermcp.builtin.BuiltinToolContext
-
Runs
tasksynchronously on the main thread and completes the mono with its result or error. - runSyncValue(Callable<T>) - Method in record class eu.mrapik.minecraftservermcp.builtin.BuiltinToolContext
-
Runs arbitrary main-thread work (e.g.
S
- SCHEMA_VERSION - Static variable in class eu.mrapik.minecraftservermcp.util.ToolResults
-
Version number incremented when the envelope fields or semantics change.
- SCHEME - Static variable in class eu.mrapik.minecraftservermcp.builtin.resources.BuiltinResourceUris
-
URI scheme for resources advertised by this server (documented for operators and MCP clients).
- SERVER_COMMAND - Static variable in class eu.mrapik.minecraftservermcp.builtin.BuiltinToolIds
-
Dispatch a server console command.
- SERVER_LOGS - Static variable in class eu.mrapik.minecraftservermcp.builtin.BuiltinToolIds
-
Tail of
logs/latest.logunder the server directory. - ServerCommandToolSpec - Class in eu.mrapik.minecraftservermcp.builtin.command
-
MCP tool that runs a command as the server console, subject to
CommandPolicyfor the caller's token. - ServerFilePaths - Record Class in eu.mrapik.minecraftservermcp.fs
-
Canonical Minecraft server root directory and helpers to resolve user-supplied relative paths safely.
- ServerFilePaths(File) - Constructor for record class eu.mrapik.minecraftservermcp.fs.ServerFilePaths
-
Creates an instance of a
ServerFilePathsrecord class. - ServerLogsToolSpec - Class in eu.mrapik.minecraftservermcp.builtin.logs
-
MCP tool that returns a bounded tail of
logs/latest.logunder the server root. - serverPaths() - Method in interface eu.mrapik.minecraftservermcp.api.McpToolInvocation
-
Paths relative to the Minecraft server root directory, with traversal checks.
- serverPaths() - Method in record class eu.mrapik.minecraftservermcp.internal.McpToolInvocationImpl
-
Returns the value of the
serverPathsrecord component. - serverRoot() - Method in record class eu.mrapik.minecraftservermcp.fs.ServerFilePaths
-
Returns the value of the
serverRootrecord component. - servicesManager() - Method in interface eu.mrapik.minecraftservermcp.internal.BukkitAccess
-
Returns the services manager, used for registering and looking up MCP tool implementations.
- servicesManager() - Method in class eu.mrapik.minecraftservermcp.internal.SpigotBukkitAccess
- settings() - Method in record class eu.mrapik.minecraftservermcp.builtin.BuiltinToolContext
-
Returns the value of the
settingsrecord component. - SpigotBukkitAccess - Class in eu.mrapik.minecraftservermcp.internal
-
Production
BukkitAccessbacked by Spigot'sBukkitstatic facade. - SpigotBukkitAccess() - Constructor for class eu.mrapik.minecraftservermcp.internal.SpigotBukkitAccess
- ssl() - Method in class eu.mrapik.minecraftservermcp.config.PluginSettings
-
Optional TLS listener; when
SslSettings.enabled()is true, clients may usehttpsonSslSettings.port(). - SslSettings - Class in eu.mrapik.minecraftservermcp.config
-
Optional TLS (HTTPS) listener for the embedded MCP server.
- start() - Method in class eu.mrapik.minecraftservermcp.mcp.McpHttpServer
-
Starts Jetty; call from the plugin's
onEnableafter construction. - stop() - Method in class eu.mrapik.minecraftservermcp.mcp.McpHttpServer
-
Stops the MCP server and Jetty; idempotent aside from logged warnings.
- string(Map<String, Object>, String) - Static method in class eu.mrapik.minecraftservermcp.util.ToolArguments
-
Reads a string argument; coerces non-null values with
Object.toString(). - stringEquals(String, String) - Static method in class eu.mrapik.minecraftservermcp.security.TimingSafe
-
Compares two strings for equality using
MessageDigest.isEqual(byte[], byte[])on UTF-8 bytes.
T
- TimingSafe - Class in eu.mrapik.minecraftservermcp.security
-
Constant-time comparisons for secret strings (e.g.
- toJson(Object) - Static method in class eu.mrapik.minecraftservermcp.builtin.player.PlayerSnapshots
-
Serializes snapshot data to a JSON string using the shared
PlayerSnapshots.JSONmapper. - token() - Method in record class eu.mrapik.minecraftservermcp.config.TokenAccessProfile
-
Secret value clients must present; must match exactly (including no extra whitespace after trim in the HTTP layer).
- TokenAccessProfile - Record Class in eu.mrapik.minecraftservermcp.config
-
One named entry under
accessinconfig.yml: a shared secret token and a map ofToolAccessConfigkeyed by MCP tool id. - TokenAccessProfile(String, String, Map<String, ToolAccessConfig>) - Constructor for record class eu.mrapik.minecraftservermcp.config.TokenAccessProfile
-
Canonical constructor; stores an unmodifiable copy of
tools. - tokenToProfile() - Method in class eu.mrapik.minecraftservermcp.config.PluginSettings
-
All configured token-to-profile mappings.
- tool() - Method in interface eu.mrapik.minecraftservermcp.api.McpToolDefinition
-
Metadata advertised to MCP clients.
- ToolAccessConfig - Record Class in eu.mrapik.minecraftservermcp.config
-
Policy for a single MCP tool id under
access.<profile>.tools.<toolId>. - ToolAccessConfig(boolean, List<String>, List<String>, List<String>, List<String>, List<String>, List<String>, Map<String, Object>) - Constructor for record class eu.mrapik.minecraftservermcp.config.ToolAccessConfig
-
Canonical constructor; stores an unmodifiable copy of
extra. - ToolArguments - Class in eu.mrapik.minecraftservermcp.util
-
Helpers for reading string-keyed maps: MCP
McpSchema.CallToolRequest.arguments()(client JSON) andToolAccessConfig.extra()(YAML). - toolConfig() - Method in interface eu.mrapik.minecraftservermcp.api.McpToolInvocation
-
Effective policy for
McpToolDefinition.id()under this profile. - toolConfig() - Method in record class eu.mrapik.minecraftservermcp.internal.McpToolInvocationImpl
-
Returns the value of the
toolConfigrecord component. - toolConfig(String) - Method in record class eu.mrapik.minecraftservermcp.config.TokenAccessProfile
-
Returns the policy for
toolId, orToolAccessConfig.permissiveDefault()if the profile defines notools.<toolId>block. - ToolInvocationGate - Class in eu.mrapik.minecraftservermcp.internal
-
Bridges MCP
McpToolDefinitioninstances to the SDK'sMcpServerFeatures.AsyncToolSpecificationby enforcing access control before the handler runs. - toolOwningPlugin(String) - Method in interface eu.mrapik.minecraftservermcp.api.MinecraftServerMcp
-
Returns which Bukkit plugin registered the given MCP tool name, for ownership checks in
MinecraftServerMcp.unregisterToolAs(java.lang.String, org.bukkit.plugin.Plugin). - toolOwningPlugin(String) - Method in class eu.mrapik.minecraftservermcp.internal.MinecraftServerMcpImpl
- ToolResults - Class in eu.mrapik.minecraftservermcp.util
-
JSON envelopes for MCP
McpSchema.CallToolResultpayloads and for resource bodies that reuse the same shape. - tools() - Method in record class eu.mrapik.minecraftservermcp.config.TokenAccessProfile
-
Unmodifiable view of all configured tool sections for this profile.
- toString() - Method in record class eu.mrapik.minecraftservermcp.builtin.BuiltinToolContext
-
Returns a string representation of this record class.
- toString() - Method in record class eu.mrapik.minecraftservermcp.config.TokenAccessProfile
-
Returns a string representation of this record class.
- toString() - Method in record class eu.mrapik.minecraftservermcp.config.ToolAccessConfig
-
Returns a string representation of this record class.
- toString() - Method in record class eu.mrapik.minecraftservermcp.fs.ServerFilePaths
-
Returns a string representation of this record class.
- toString() - Method in record class eu.mrapik.minecraftservermcp.internal.McpToolInvocationImpl
-
Returns a string representation of this record class.
- TransportContextKeys - Class in eu.mrapik.minecraftservermcp.mcp
-
String keys used in
McpTransportContext.get(String)metadata.
U
- unregisterTool(String) - Method in interface eu.mrapik.minecraftservermcp.api.MinecraftServerMcp
-
Removes a tool from the MCP server by its advertised MCP name.
- unregisterTool(String) - Method in class eu.mrapik.minecraftservermcp.internal.MinecraftServerMcpImpl
- unregisterToolAs(String, Plugin) - Method in interface eu.mrapik.minecraftservermcp.api.MinecraftServerMcp
-
Removes a tool only if
caller's name matches the plugin that registered it (seeMinecraftServerMcp.toolOwningPlugin(String)). - unregisterToolAs(String, Plugin) - Method in class eu.mrapik.minecraftservermcp.internal.MinecraftServerMcpImpl
W
- wrapDefinition(McpToolDefinition, Supplier<PluginSettings>, JavaPlugin, ServerFilePaths) - Static method in class eu.mrapik.minecraftservermcp.internal.ToolInvocationGate
-
Wraps a definition so every invocation goes through
ToolInvocationGate.runWithAccess(java.lang.String, io.modelcontextprotocol.server.McpAsyncServerExchange, io.modelcontextprotocol.spec.McpSchema.CallToolRequest, java.util.function.Supplier<eu.mrapik.minecraftservermcp.config.PluginSettings>, org.bukkit.plugin.java.JavaPlugin, eu.mrapik.minecraftservermcp.fs.ServerFilePaths, java.util.function.Function<eu.mrapik.minecraftservermcp.api.McpToolInvocation, reactor.core.publisher.Mono<io.modelcontextprotocol.spec.McpSchema.CallToolResult>>). - wrapResource(String, McpSchema.Resource, Supplier<PluginSettings>, JavaPlugin, ServerFilePaths, ResourceInvocationGate.ResourceHandler) - Static method in class eu.mrapik.minecraftservermcp.internal.ResourceInvocationGate
-
Builds an
McpServerFeatures.AsyncResourceSpecificationwhose read handler validates the transport token and profile before invoking the delegate. - wrapTemplate(String, McpSchema.ResourceTemplate, Supplier<PluginSettings>, JavaPlugin, ServerFilePaths, ResourceInvocationGate.ResourceHandler) - Static method in class eu.mrapik.minecraftservermcp.internal.ResourceInvocationGate
-
Builds an
McpServerFeatures.AsyncResourceTemplateSpecificationfor a URI template, with the same access checks asResourceInvocationGate.wrapResource(java.lang.String, io.modelcontextprotocol.spec.McpSchema.Resource, java.util.function.Supplier<eu.mrapik.minecraftservermcp.config.PluginSettings>, org.bukkit.plugin.java.JavaPlugin, eu.mrapik.minecraftservermcp.fs.ServerFilePaths, eu.mrapik.minecraftservermcp.internal.ResourceInvocationGate.ResourceHandler).
All Classes and Interfaces|All Packages|Constant Field Values