Configuring your client to use the MCP server

Before you begin:

The PE console host must be reachable from the developer’s machine.
The developer’s machine must trust the PE console CA certificate. See Get the Puppet CA certificate chain in Puppet Enterprise.
You must have the infrastructure_assistant:use permission.
To use the get_device_info tool, you must have the task run permission for the task edgeops::netconf_discover.
You will need a PE API key. See Generate a token in the console.

Configuring documentation generation

Code assist’s MCP server entity documentation tools require Puppet Server to generate documentation for your environments. This is enabled by default but can be configured by editing the PE Master node group in the console.

To configure documentation generation:

In the console, click Node groups.
Expand PE Infrastructure and select PE Master.
On the Data tab, locate the puppet_enterprise::master::file_sync class.
Set the following parameters as needed:

The listed defaults are the file sync application’s defaults, which apply when the Puppet parameters are undef.

generate_docs

Description: Enable or disable documentation generation. Set to false to completely disable.

Default: true
generate_docs_environments

Description: Array of environments to generate docs for. An empty array generates docs for all environments.
Default: ['production']
generate_docs_concurrency

Description: Maximum number of environments to generate docs for concurrently.

Default: 3
generate_docs_timeout

Description: Timeout in seconds to wait for documentation generation to complete.

Default: 300

5. Click Commit changes.

6. Run Puppet on your primary server to apply the changes.

Examples

Generate docs for multiple environments:

Set generate_docs_environments to ['production', 'development', 'staging']

Generate docs for all environments:

Set generate_docs_environments to ["all-puppet-environment"]

Disable documentation generation:

Set generate_docs to false