Model Context Protocol (MCP) server

The Model Context Protocol (MCP) server is a powerful tool designed to enhance the authoring experience of ubcode documentation projects. It provides tools for LLMs to utilise, for understanding the project and requirements graph.

The MCP server starts automatically when the ubcode extension is activated. You can check its status within the command palette by searching for “MCP: List Servers”, or in the copilot window. See the VS Code MCP documentation for more details on using MCP servers.

By default, the MCP uses the root of your project workspace to retrieve cached information. This can be configured though, using the ubcode.mcp.defaultConfig VS Code setting.

Tip

To ensure that the MCP server has real-time, up-to-date, information about your project as it performs any modifications, enable server.index_on_save = true in your ubproject.toml (see server configuration).