Skip to content

Commit e0c8dbc

Browse files
Merge pull request #4 from ShahryarShabani/docs-update-confluence-and-config
docs: Update README with Confluence toolset and config file info
2 parents 91d9bda + cc78106 commit e0c8dbc

File tree

1 file changed

+45
-5
lines changed

1 file changed

+45
-5
lines changed

README.md

Lines changed: 45 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -184,6 +184,33 @@ uvx kubernetes-mcp-server@latest --help
184184
| `--read-only` | If set, the MCP server will run in read-only mode, meaning it will not allow any write operations (create, update, delete) on the Kubernetes cluster. This is useful for debugging or inspecting the cluster without making changes. |
185185
| `--disable-destructive` | If set, the MCP server will disable all destructive operations (delete, update, etc.) on the Kubernetes cluster. This is useful for debugging or inspecting the cluster without accidentally making changes. This option has no effect when `--read-only` is used. |
186186
| `--toolsets` | Comma-separated list of toolsets to enable. Check the [🛠️ Tools and Functionalities](#tools-and-functionalities) section for more information. |
187+
| `--config` | Path to a TOML configuration file. If provided, the server will load its configuration from this file. |
188+
189+
### Configuration File
190+
191+
In addition to command-line arguments, the server can be configured using a TOML file specified with the `--config` flag.
192+
This allows for more advanced configuration options that are not available through command-line arguments.
193+
194+
#### Confluence Toolset
195+
196+
To enable the Confluence toolset, you need to provide the URL, username, and an API token for your Confluence instance in the configuration file.
197+
198+
**Example `config.toml`:**
199+
```toml
200+
[confluence]
201+
url = "https://your-confluence-domain.com"
202+
username = "your-username"
203+
token = "your-api-token"
204+
```
205+
206+
#### Advanced Configuration
207+
208+
The TOML configuration file also supports more advanced options, such as:
209+
210+
- **`denied_resources`**: A list of Kubernetes resources that should not be accessible through the server.
211+
- **OAuth Integration**: A comprehensive set of options to configure OIDC-based authentication and authorization for the server, including settings for token validation, client registration, and token exchange (STS).
212+
213+
For a complete list of all available configuration options, please refer to the `pkg/config/config.go` source file.
187214

188215
## 🛠️ Tools and Functionalities <a id="tools-and-functionalities"></a>
189216

@@ -197,11 +224,12 @@ The following sets of tools are available (all on by default):
197224

198225
<!-- AVAILABLE-TOOLSETS-START -->
199226

200-
| Toolset | Description |
201-
|---------|-------------------------------------------------------------------------------------|
202-
| config | View and manage the current local Kubernetes configuration (kubeconfig) |
203-
| core | Most common tools for Kubernetes management (Pods, Generic Resources, Events, etc.) |
204-
| helm | Tools for managing Helm charts and releases |
227+
| Toolset | Description |
228+
|------------|-------------------------------------------------------------------------------------|
229+
| config | View and manage the current local Kubernetes configuration (kubeconfig) |
230+
| confluence | Tools for interacting with Confluence |
231+
| core | Most common tools for Kubernetes management (Pods, Generic Resources, Events, etc.) |
232+
| helm | Tools for managing Helm charts and releases |
205233

206234
<!-- AVAILABLE-TOOLSETS-END -->
207235

@@ -220,6 +248,18 @@ The following sets of tools are available (all on by default):
220248

221249
<details>
222250

251+
<summary>confluence</summary>
252+
253+
- **confluence.createPage** - Create a new page in Confluence.
254+
- `space_key` (`string`) **(required)** - The key of the space to create the page in.
255+
- `title` (`string`) **(required)** - The title of the new page.
256+
- `content` (`string`) **(required)** - The content of the new page in Confluence Storage Format (XHTML).
257+
- `parent_id` (`string`) - Optional ID of a parent page.
258+
259+
</details>
260+
261+
<details>
262+
223263
<summary>core</summary>
224264

225265
- **events_list** - List all the Kubernetes events in the current cluster from all namespaces

0 commit comments

Comments
 (0)