You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/20_setup.md
+54-9Lines changed: 54 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,13 +5,24 @@
5
5
### Prerequisites
6
6
7
7
1. To run the server in a container, you will need to have [Docker] installed.
8
-
2. Once Docker is installed, you will also need to ensure Docker is running.
9
-
3. Pull the docker image `docker pull ghcr.io/mia-platform/console-mcp-server`
10
-
4. Login to Mia-Platform. You have two options:
11
-
- (a) *User Authentication* - Use miactl authentication: if you have [`miactl`][miactl] installed you can login and
12
-
the same session will then be used by the mcp server to authenticate. To login just type `miactl company list`, or any other miactl command, the browser will be opened and you can use your credentatials to login. You will be able to access to all companies and projects that have been granted to your user.
13
-
- (b) *Service Account* - [Create a Mia-Platform Service Account] with `Client Secret Basic` authorization mode (the only one supported at this time) the `Client Secret Basic` one. In that case you can access to just one company at a time.
14
-
8
+
1. Once Docker is installed, you will also need to ensure Docker is running.
9
+
1. Pull the docker image `docker pull ghcr.io/mia-platform/console-mcp-server`
10
+
1. Login to Mia-Platform. You have two options:
11
+
- (a) *User Authentication* - Use miactl authentication: if you have [`miactl`][miactl] installed you can login and
12
+
the same session will then be used by the mcp server to authenticate. To login just type `miactl company list`,
13
+
or any other miactl command, the browser will be opened and you can use your credentials to login. You will be
14
+
able to access to all companies and projects that have been granted to your user.
15
+
- (b) *Service Account* - [Create a Mia-Platform Service Account] with `Client Secret Basic` authorization mode
16
+
(the only one supported at this time) the `Client Secret Basic` one. In that case you can access to just one
17
+
company at a time.
18
+
19
+
> [!WARNING]
20
+
> When using miactl session, auto-refresh by the MCP Server is not currently supported,
21
+
> once the session created with miactl expires you have to refresh it with miactl again.
22
+
---
23
+
> [!IMPORTANT]
24
+
> When using miactl session, the host you provide to the MCP Server **MUST** be the exact same as the one
25
+
> you have logged in with miactl, including scheme and any possible trailing slash.
15
26
16
27
### VS Code
17
28
@@ -26,7 +37,7 @@ The `mcp` key is not needed in the `.vscode/mcp.json` file.
26
37
Also note that you can change the host of the Console instance to your custom installation
27
38
:::
28
39
29
-
This is the configuration if you are using mictl (a)
40
+
This is the configuration if you are using miactl (a)
30
41
31
42
```json
32
43
{
@@ -52,7 +63,6 @@ This is the configuration if you are using mictl (a)
52
63
}
53
64
```
54
65
55
-
56
66
This is the configuration if you are using Service Account (b)
57
67
58
68
```json
@@ -139,6 +149,41 @@ More about using MCP server tools in [VS Code's agent mode documentation].
139
149
}
140
150
```
141
151
152
+
### Gemini CLI
153
+
154
+
Add `mia-platform-console` in `mcpServers` in file `~/.gemini/settings.json`.
0 commit comments