Skip to content
Draft
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
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
53 changes: 46 additions & 7 deletions src/oci-compute-instance-agent-mcp-server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,57 @@

This server provides tools for interacting with Oracle Cloud Infrastructure (OCI) Compute Instance Agent service.

## 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-compute-instance-agent": {
"type": "stdio",
"command": "uvx",
"args": [
"oracle.oci-compute-instance-agent-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-compute-instance-agent-mcp-server
```bash
ORACLE_MCP_HOST=127.0.0.1 ORACLE_MCP_PORT=8000 uvx oracle.oci-compute-instance-agent-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-compute-instance-agent-mcp-server
```json
{
"mcpServers": {
"oci-compute-instance-agent": {
"type": "streamableHttp",
"url": "http://127.0.0.1:8000/mcp"
}
}
}
```

## Tools
Expand Down
53 changes: 46 additions & 7 deletions src/oci-compute-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 interact with the OCI Compute resources.
It includes tools to help with managing compute instances.

## 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-compute": {
"type": "stdio",
"command": "uvx",
"args": [
"oracle.oci-compute-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-compute-mcp-server
```bash
ORACLE_MCP_HOST=127.0.0.1 ORACLE_MCP_PORT=8000 uvx oracle.oci-compute-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-compute-mcp-server
```json
{
"mcpServers": {
"oci-compute": {
"type": "streamableHttp",
"url": "http://127.0.0.1:8000/mcp"
}
}
}
```

## Tools
Expand Down
53 changes: 50 additions & 3 deletions src/oci-database-mcp-server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,57 @@

This server provides tools to interact with the OCI Database service.

## 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-database": {
"type": "stdio",
"command": "uvx",
"args": [
"oracle.oci-database-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-database-mcp-server
```

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
uv run oracle.oci-database-mcp-server
```json
{
"mcpServers": {
"oci-database": {
"type": "streamableHttp",
"url": "http://127.0.0.1:8000/mcp"
}
}
}
```

## Environment Variables
Expand Down
Loading