diff --git a/README.md b/README.md index 68d833d..ad57eb9 100644 --- a/README.md +++ b/README.md @@ -202,7 +202,9 @@ data: - retry jobs or trigger custom checkouts (with a token) Tools that only read data are annotated as read-only, so MCP clients can -require confirmation before the job-triggering ones run. +require confirmation before the job-triggering ones run. The MCP server is +experimental: tool names, parameters and response formats may change +between releases. MCP support is an optional extra: diff --git a/docs/mcp.md b/docs/mcp.md index e2bfe8e..933b6ab 100644 --- a/docs/mcp.md +++ b/docs/mcp.md @@ -7,6 +7,10 @@ description = 'Run an MCP server exposing KernelCI data and actions to AI agents This command runs an MCP (Model Context Protocol) server so AI agents and automation tools can query KernelCI results and drive Maestro jobs. +> **Experimental**: tool names, parameters and response formats may +> change between releases. Please report any issues on the +> [issue tracker](https://github.com/kernelci/kci-dev/issues). + MCP support is an optional extra: ```sh diff --git a/kcidev/mcp/__init__.py b/kcidev/mcp/__init__.py index 85e30a4..0d7445d 100644 --- a/kcidev/mcp/__init__.py +++ b/kcidev/mcp/__init__.py @@ -7,7 +7,8 @@ from kcidev.libs.common import kcidev_version from kcidev.mcp import tools_dashboard, tools_maestro -SERVER_INSTRUCTIONS = """KernelCI MCP server. +SERVER_INSTRUCTIONS = """KernelCI MCP server (experimental: tools, +parameters and response formats may change between releases). Query KernelCI build, boot and test results and known issues from the web dashboard, inspect Maestro nodes, and, when a token is configured, diff --git a/kcidev/subcommands/mcp.py b/kcidev/subcommands/mcp.py index f162316..f3c5828 100644 --- a/kcidev/subcommands/mcp.py +++ b/kcidev/subcommands/mcp.py @@ -11,6 +11,12 @@ @click.command( help="""Run an MCP (Model Context Protocol) server exposing KernelCI. +EXPERIMENTAL: tool names, parameters and response formats may change +between releases. Please report any issues at: + +\b +https://github.com/kernelci/kci-dev/issues + Read-only dashboard query tools are always available. Maestro node lookup tools are enabled when the configured instance has an 'api' URL, and job retry/checkout trigger tools when it also has a 'pipeline' URL