Package org.machanism.machai.mcp.server

Class AbstractMcpServer

java.lang.Object

org.machanism.machai.mcp.server.AbstractMcpServer

Direct Known Subclasses:

AbstractHttpMcpServer, StdioMcpServer

public abstract class AbstractMcpServer
extends Object

Base implementation of a Model Context Protocol (MCP) server.

This class provides common hooks, constants, and working directory management for custom MCP server implementations designed to interact with generative-AI models.

Since:

1.2.0

Author:

Viktor Tovstyi

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static interface	AbstractMcpServer.ToolSpecificationBuilder<E>	Interface for building tool and tool specification objects for MCP servers.

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	ENABLED_TOOLS_PARAM_NAME
static final String	MACHAI_MACHANISM_HOMEPAGE	The homepage URL for the Machai MCP server.
static final String	MACHAI_MACHANISM_ICON	The icon URL for the Machai MCP server.
private File	projectDir

Constructor Summary

Constructors

Constructor	Description
AbstractMcpServer()	Constructs a new AbstractMcpServer.

Method Summary

Modifier and Type	Method	Description
protected String[]	getEnabledTools(Configurator config)	Reads the optional enabled-tool list from the server configuration.
File	getProjectDir()	Returns the configured project directory.
void	setProjectDir(File projectDir)	Sets the project directory used by server tools.
(package private) abstract void	start()	Starts the MCP server.
(package private) abstract void	tools(Configurator config)	Registers or defines the available tools for this MCP server.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ENABLED_TOOLS_PARAM_NAME

private static final String ENABLED_TOOLS_PARAM_NAME

See Also:

• Constant Field Values

MACHAI_MACHANISM_HOMEPAGE

public static final String MACHAI_MACHANISM_HOMEPAGE

The homepage URL for the Machai MCP server.

See Also:

• Constant Field Values

MACHAI_MACHANISM_ICON

public static final String MACHAI_MACHANISM_ICON

The icon URL for the Machai MCP server.

See Also:

• Constant Field Values

projectDir

private File projectDir

Constructor Details

AbstractMcpServer

AbstractMcpServer()

Constructs a new AbstractMcpServer.

Method Details

getEnabledTools

protected String[] getEnabledTools(Configurator config)

Reads the optional enabled-tool list from the server configuration. Values may be separated by spaces, commas, semicolons, or whitespace.

Parameters:

config - configuration source; expected to be non-null

Returns:

enabled tool names, or null when no restriction is configured

tools

abstract void tools(Configurator config)

Registers or defines the available tools for this MCP server.

Subclasses must implement this method to provide tool registration logic.

start

abstract void start()
             throws McpServerStartupException

Starts the MCP server.

Subclasses must implement this method to provide server startup logic.

Throws:

McpServerStartupException - if the server fails to start

setProjectDir

public void setProjectDir(File projectDir)

Sets the project directory used by server tools.

Parameters:

projectDir - project directory to use, or null when request-specific

getProjectDir

public File getProjectDir()

Returns the configured project directory.

Returns:

project directory, or null when request-specific