Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 29 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,10 @@ For macOS/Linux:
```json
{
"mcpServers": {
"oracle-oci-api-mcp-server": {
"oracle-oci-cloud-mcp-server": {
"command": "uvx",
"args": [
"oracle.oci-api-mcp-server@latest"
"oracle.oci-cloud-mcp-server@latest"
],
"env": {
"FASTMCP_LOG_LEVEL": "ERROR"
Expand All @@ -58,7 +58,7 @@ For macOS/Linux:
To connect to an MCP server running in HTTP streaming mode:
Assuming you started the server by running:
```bash
ORACLE_MCP_HOST=127.0.0.1 ORACLE_MCP_PORT=8888 uvx oracle.oci-api-mcp-server
ORACLE_MCP_HOST=127.0.0.1 ORACLE_MCP_PORT=8888 uvx oracle.oci-cloud-mcp-server
```
then place the following in your MCP client configuration:
:warning: NOTE: the `type` attribute differs across MCP clients; some use `http` as the
Expand All @@ -67,7 +67,7 @@ transport value while others (like Cline) expect `streamableHttp`.
```json
{
"mcpServers": {
"oracle-oci-api-mcp-server": {
"oracle-oci-cloud-mcp-server": {
"type": "streamableHttp",
"url": "http://127.0.0.1:8888/mcp"
}
Expand All @@ -86,20 +86,20 @@ https://podman.io/docs/installation

### Building the Container Image

You can build the container image using the following command. The command shows building the container image for the oci-api-mcp-server.
You can build the container image using the following command. The command shows building the container image for the oci-cloud-mcp-server.

```sh
SUBDIRS=src/oci-api-mcp-server make containerize
SUBDIRS=src/oci-cloud-mcp-server make containerize
```
The above command builds the container image tagged as `oracle.oci-api-mcp-server:latest`.
The above command builds the container image tagged as `oracle.oci-cloud-mcp-server:latest`.

### MCP Client Configuration

For examples of configuring MCP clients to run the server using podman, see the client-specific sections below. Configurations typically involve using `podman run` as the command, with appropriate flags and volume mounts for credentials if needed (e.g., mounting `~/.oci` for OCI servers).

Alternatively, if you want to use HTTP transport using the podman container, then start the MCP server using the following command and configure your client as mentioned in Quickstart section above.
```bash
podman run -v "/path/to/your/.oci:/app/.oci" -e ORACLE_MCP_HOST=0.0.0.0 -e ORACLE_MCP_PORT=8888 -p 8888:8888 oracle.oci-api-mcp-server:latest
podman run -v "/path/to/your/.oci:/app/.oci" -e ORACLE_MCP_HOST=0.0.0.0 -e ORACLE_MCP_PORT=8888 -p 8888:8888 oracle.oci-cloud-mcp-server:latest
```
⚠️ **NOTE**: Ensure that all the fields that are paths to files in `/path/to/your/.oci/config` uses the **~** character so that the path resolves both inside and outside the container; for example:
```bash
Expand Down Expand Up @@ -155,11 +155,11 @@ For macOS/Linux:
```json
{
"mcpServers": {
"oracle-oci-api-mcp-server": {
"oracle-oci-cloud-mcp-server": {
"type": "stdio",
"command": "uvx",
"args": [
"oracle.oci-api-mcp-server@latest"
"oracle.oci-cloud-mcp-server@latest"
],
"env": {
"OCI_CONFIG_PROFILE": "<profile_name>",
Expand All @@ -170,18 +170,18 @@ For macOS/Linux:
}
```

Alternatively, to run using podman (example for oracle.oci-api-mcp-server):
Alternatively, to run using podman (example for oracle.oci-cloud-mcp-server):

```json
{
"mcpServers": {
"oracle-oci-api-mcp-server": {
"oracle-oci-cloud-mcp-server": {
"autoApprove": [],
"disabled": false,
"timeout": 60,
"type": "stdio",
"command": "podman",
"args": ["run", "-i", "--rm", "-v", "/path/to/your/.oci:/app/.oci", "oracle.oci-api-mcp-server:latest"],
"args": ["run", "-i", "--rm", "-v", "/path/to/your/.oci:/app/.oci", "oracle.oci-cloud-mcp-server:latest"],
"env": {
"FASTMCP_LOG_LEVEL": "INFO"
}
Expand Down Expand Up @@ -222,11 +222,11 @@ For macOS/Linux:
```json
{
"mcpServers": {
"oracle-oci-api-mcp-server": {
"oracle-oci-cloud-mcp-server": {
"type": "stdio",
"command": "uvx",
"args": [
"oracle.oci-api-mcp-server"
"oracle.oci-cloud-mcp-server"
],
"env": {
"OCI_CONFIG_PROFILE": "<profile_name>",
Expand All @@ -237,15 +237,15 @@ For macOS/Linux:
}
```

Alternatively, to run using podman (example for oracle-oci-api-mcp-server):
Alternatively, to run using podman (example for oracle-oci-cloud-mcp-server):

```json
{
"mcpServers": {
"oracle-oci-api-mcp-server": {
"oracle-oci-cloud-mcp-server": {
"type": "stdio",
"command": "podman",
"args": ["run", "-i", "--rm", "-v", "/path/to/your/.oci:/app/.oci", "oracle.oci-api-mcp-server:latest"],
"args": ["run", "-i", "--rm", "-v", "/path/to/your/.oci:/app/.oci", "oracle.oci-cloud-mcp-server:latest"],
"env": {
"FASTMCP_LOG_LEVEL": "INFO"
}
Expand Down Expand Up @@ -294,11 +294,11 @@ For macOS/Linux:
```json
{
"mcpServers": {
"oracle-oci-api-mcp-server": {
"oracle-oci-cloud-mcp-server": {
"type": "stdio",
"command": "uvx",
"args": [
"oracle.oci-api-mcp-server"
"oracle.oci-cloud-mcp-server"
],
"env": {
"OCI_CONFIG_PROFILE": "<profile_name>",
Expand All @@ -309,15 +309,15 @@ For macOS/Linux:
}
```

Alternatively, to run using podman (example for oracle-oci-api-mcp-server):
Alternatively, to run using podman (example for oracle-oci-cloud-mcp-server):

```json
{
"mcpServers": {
"oracle-oci-api-mcp-server": {
"oracle-oci-cloud-mcp-server": {
"type": "stdio",
"command": "podman",
"args": ["run", "-i", "--rm", "-v", "/path/to/your/.oci:/app/.oci", "oracle.oci-api-mcp-server:latest"],
"args": ["run", "-i", "--rm", "-v", "/path/to/your/.oci:/app/.oci", "oracle.oci-cloud-mcp-server:latest"],
"env": {
"FASTMCP_LOG_LEVEL": "INFO"
}
Expand Down Expand Up @@ -368,11 +368,11 @@ For macOS/Linux:
```json
{
"mcpServers": {
"oracle-oci-api-mcp-server": {
"oracle-oci-cloud-mcp-server": {
"command": "uv",
"args": [
"run",
"oracle.oci-api-mcp-server"
"oracle.oci-cloud-mcp-server"
],
"env": {
"VIRTUAL_ENV": "<path to your cloned repo>/mcp/.venv",
Expand Down Expand Up @@ -410,12 +410,12 @@ update it as needed. For instance:
```json
{
"mcpServers": {
"oracle-oci-api-mcp-server": {
"oracle-oci-cloud-mcp-server": {
"type": "stdio",
"command": "uv",
"args": [
"run",
"oracle.oci-api-mcp-server"
"oracle.oci-cloud-mcp-server"
],
"env": {
"VIRTUAL_ENV": "<path to your cloned repo>/oci-mcp/.venv",
Expand All @@ -437,7 +437,7 @@ make install

then start the server:
```bash
VIRTUAL_ENV=$(pwd)/.venv ORACLE_MCP_HOST=127.0.0.1 ORACLE_MCP_PORT=8888 uv run oracle.oci-api-mcp-server
VIRTUAL_ENV=$(pwd)/.venv ORACLE_MCP_HOST=127.0.0.1 ORACLE_MCP_PORT=8888 uv run oracle.oci-cloud-mcp-server
```

### Inspector
Expand Down Expand Up @@ -483,7 +483,7 @@ uv run --index=https://test.pypi.org/simple <mcp server package>
```
example:
```bash
uv run --index=https://test.pypi.org/simple oracle.oci-api-mcp-server
uv run --index=https://test.pypi.org/simple oracle.oci-cloud-mcp-server
```

### Publish packages
Expand Down
53 changes: 46 additions & 7 deletions src/oci-api-mcp-server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,57 @@
This server provides tools to run OCI CLI commands to interact with the OCI services.
It includes tools to help with OCI command execution and provide helpful information.

## Running the server
## MCP client configuration (recommended)

Most users should configure their MCP client to launch the server, rather than starting it manually.

Add a stanza like this to your MCP client config (often called `mcp.json`; example shown is **stdio**):

```json
{
"mcpServers": {
"oci-api": {
"type": "stdio",
"command": "uvx",
"args": [
"oracle.oci-api-mcp-server"
],
"env": {
"OCI_CONFIG_PROFILE": "DEFAULT"
}
}
}
}
```

## Run the server locally (HTTP transport)

Most MCP clients run this server for you over **stdio** (see above). If you want to run the server as a standalone
service and connect to it over HTTP (**streamable HTTP**), you can.

### STDIO transport mode
1) Start the server in HTTP mode (choose host/port):

```sh
uvx oracle.oci-api-mcp-server
```bash
ORACLE_MCP_HOST=127.0.0.1 ORACLE_MCP_PORT=8000 uvx oracle.oci-api-mcp-server
```

### HTTP streaming transport mode
This will expose the MCP endpoint at:

`http://127.0.0.1:8000/mcp`

2) Configure your MCP client to connect via `streamableHttp`:

> Note: MCP client configuration varies by client/tooling. Some clients refer to streamable HTTP as just `http`.

```sh
ORACLE_MCP_HOST=<hostname/IP address> ORACLE_MCP_PORT=<port number> uvx oracle.oci-api-mcp-server
```json
{
"mcpServers": {
"oci-api": {
"type": "streamableHttp",
"url": "http://127.0.0.1:8000/mcp"
}
}
}
```

## Tools
Expand Down
53 changes: 46 additions & 7 deletions src/oci-cloud-guard-mcp-server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,57 @@
This package implements certain functions of the [OCI Cloud Guard Service](https://docs.oracle.com/en-us/iaas/Content/cloud-guard/home.htm).
It includes tools to help with managing cloud guard problems.

## Running the server
## MCP client configuration (recommended)

Most users should configure their MCP client to launch the server, rather than starting it manually.

Add a stanza like this to your MCP client config (often called `mcp.json`; example shown is **stdio**):

```json
{
"mcpServers": {
"oci-cloud-guard": {
"type": "stdio",
"command": "uvx",
"args": [
"oracle.oci-cloud-guard-mcp-server"
],
"env": {
"OCI_CONFIG_PROFILE": "DEFAULT"
}
}
}
}
```

## Run the server locally (HTTP transport)

Most MCP clients run this server for you over **stdio** (see above). If you want to run the server as a standalone
service and connect to it over HTTP (**streamable HTTP**), you can.

### STDIO transport mode
1) Start the server in HTTP mode (choose host/port):

```sh
uvx oracle.oci-cloud-guard-mcp-server
```bash
ORACLE_MCP_HOST=127.0.0.1 ORACLE_MCP_PORT=8000 uvx oracle.oci-cloud-guard-mcp-server
```

### HTTP streaming transport mode
This will expose the MCP endpoint at:

`http://127.0.0.1:8000/mcp`

2) Configure your MCP client to connect via `streamableHttp`:

> Note: MCP client configuration varies by client/tooling. Some clients refer to streamable HTTP as just `http`.

```sh
ORACLE_MCP_HOST=<hostname/IP address> ORACLE_MCP_PORT=<port number> uvx oracle.oci-cloud-guard-mcp-server
```json
{
"mcpServers": {
"oci-cloud-guard": {
"type": "streamableHttp",
"url": "http://127.0.0.1:8000/mcp"
}
}
}
```

## Tools
Expand Down
53 changes: 46 additions & 7 deletions src/oci-cloud-mcp-server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,57 @@ This server provides tools to interact with Oracle Cloud Infrastructure (OCI) se
- Invoke any OCI SDK client operation by fully-qualified client class and method name
- Discover available operations for a given OCI client

## Running the server
## MCP client configuration (recommended)

### STDIO transport mode
Most users should configure their MCP client to launch the server, rather than starting it manually.

```sh
uvx oracle.oci-cloud-mcp-server
Add a stanza like this to your MCP client config (often called `mcp.json`; example shown is **stdio**):

```json
{
"mcpServers": {
"oci-cloud": {
"type": "stdio",
"command": "uvx",
"args": [
"oracle.oci-cloud-mcp-server"
],
"env": {
"OCI_CONFIG_PROFILE": "DEFAULT"
}
}
}
}
```

## Run the server locally (HTTP transport)

Most MCP clients run this server for you over **stdio** (see above). If you want to run the server as a standalone
service and connect to it over HTTP (**streamable HTTP**), you can.

1) Start the server in HTTP mode (choose host/port):

```bash
ORACLE_MCP_HOST=127.0.0.1 ORACLE_MCP_PORT=8000 uvx oracle.oci-cloud-mcp-server
```

### HTTP streaming transport mode
This will expose the MCP endpoint at:

`http://127.0.0.1:8000/mcp`

2) Configure your MCP client to connect via `streamableHttp`:

> Note: MCP client configuration varies by client/tooling. Some clients refer to streamable HTTP as just `http`.

```sh
ORACLE_MCP_HOST=<hostname/IP address> ORACLE_MCP_PORT=<port number> uvx oracle.oci-cloud-mcp-server
```json
{
"mcpServers": {
"oci-cloud": {
"type": "streamableHttp",
"url": "http://127.0.0.1:8000/mcp"
}
}
}
```

## Tools
Expand Down
Loading
Loading