Skip to content
AI

AI Configuration

This page lists the configuration properties that control the AI assistant and the MCP server.

Overview

The MCP server is a REST plugin, so its address and availability follow the REST properties, and it is enabled by default. The assistant is off by default, and takes a list of providers with a credential for each.

Set these in config/local.properties. See Configuration.

MCP server

The MCP server has no listening port of its own. It is served by the REST server at /3forge_rest/mcp, on the Web component's ports unless REST is moved to a separate port. See MCP Server.

ami.rest.plugin.classes

Default:
1
ami.rest.plugin.classes=*,!QUERY,!ADMIN
Description:
  • Which REST plugins load. The default matches every discovered plugin except QUERY and ADMIN, so the MCP plugin (MCP) is enabled.
  • Add !MCP to the list to disable the MCP server.

ami.rest.uses.web.port

Default:
1
ami.rest.uses.web.port=web
Description:
  • Which Web component's ports serve REST, and so the MCP server.
  • Set to false to bind REST to its own socket, using ami.rest.http.port.

ami.rest.http.port

Default:
No default.
Description:
  • The port for the REST socket when ami.rest.uses.web.port=false.
  • The socket only exists once a port is set.

ami.mcp.tools.disabled

Default:
Empty.
Description:
  • A comma-delimited list of MCP tool names to hide. A trailing * matches a family of tools.

Each MCP request runs as the identity that authenticated it, either the logged-in Web session or the HTTP Basic credentials supplied by the client. There is no property that sets a fixed identity. See MCP Server.

Language model providers

The assistant is configured in the Web component's local.properties. Each provider reads its own credential and model list under ami.web.ai.<id>., where <id> is the provider id: anthropic, openai, gemini, or xai.

ami.web.ai.enabled

Default:
1
ami.web.ai.enabled=false
Description:
  • Turns the assistant on.

ami.web.ai.providers

Default:
No default. Required when AI is enabled.
Description:
  • A comma-delimited list of provider ids. The first entry is the default provider.
  • If AI is enabled and this list is unset, each user session fails to initialize.

ami.web.ai.<id>.api_key

Default:
No default.
Description:
  • The credential for a built-in provider. Provider initialization fails without it.

ami.web.ai.<id>.model

Default:
No default. Required for a built-in provider.
Description:
  • A comma-delimited list of models for the provider. The first entry is the default model.

See Ask AI Chatbot for the remaining per-provider properties and the other tunables.

Warning

Treat each key as a credential. Use the encrypted properties mechanism rather than storing it in plain text, and do not commit it to source control.