Metadata-Version: 2.4
Name: oci-documentation-mcp-server
Version: 20260519
Summary: An  Model Context Protocol (MCP) server for OCI Documentation
License-File: LICENSE
Requires-Python: >=3.10
Requires-Dist: beautifulsoup4>=4.12.0
Requires-Dist: httpx>=0.27.0
Requires-Dist: loguru>=0.7.0
Requires-Dist: markdownify>=1.1.0
Requires-Dist: mcp[cli]>=1.6.0
Requires-Dist: pydantic>=2.10.6
Description-Content-Type: text/markdown

*Inspired by: https://github.com/awslabs/mcp/tree/main/src/aws-documentation-mcp-server*

# OCI Documentation MCP Server

Model Context Protocol (MCP) server for OCI Documentation

This MCP server provides tools to search for content, and access OCI documentation.

## Change log

- 2026-5-19: change search engine to oracle help center search
- 2025-4-21: Initial release

## Features

- **Read Documentation**: Fetch and convert OCI documentation pages to markdown format
- **Search Documentation**: Search OCI documentation using search engine

## Prerequisites

### Installation Requirements

1. Install `uv` from [Astral](https://docs.astral.sh/uv/getting-started/installation/) or the [GitHub README](https://github.com/astral-sh/uv#installation)
2. Install Python 3.10 or newer using `uv python install 3.10` (or a more recent version)

## Installation

MCP config:

```json
{
  "mcpServers": {
      "oci-documentation-mcp-server": {
        "command": "uvx",
        "args": [
          "--from",
          "oci-documentation-mcp-server@latest",
          "python",
          "-m",
          "oci_documentation_mcp_server.server"
        ],
        "env": {
          "FASTMCP_LOG_LEVEL": "ERROR"
        },
        "disabled": false,
        "autoApprove": []
    },
  }
}

```


If above doesn't work, try below one:

```json
{
  "mcpServers": {
    "oci-documentation-mcp-server": {
        "command": "uvx",
        "args": ["oci-documentation-mcp-server@latest"],
        "env": {
          "FASTMCP_LOG_LEVEL": "ERROR"
        },
        "disabled": false,
        "autoApprove": []
    }
  }
}
```

## Basic Usage
Example:
 - In Cursor ask: `Write a function to download files for OCI Object Storage.`

 ![Cursor_MCP](./image/Cursor_MCP.gif)
 




## Tools

### oci_search_documentation

Searches OCI documentation based on a search phrase.

```python
oci_search_documentation(search_phrase: str, limit: int = 3, page: int = 1) -> str
```

### oci_read_documentation

Fetches an OCI documentation page and returns content partially as markdown.

```python
oci_read_documentation(url: str, start_index: int = 0, max_lines: int = 10) -> str
```

**Parameters:**
- `url`: URL of the OCI documentation page to read (must be from docs.oracle.com and end with .htm or .html)
- `start_index`: Line number to start reading from (default: 0)
- `max_lines`: Maximum number of lines to return (default: 10)



## DEV

```bash
run --directory "D:/MCP/oci-documentation-mcp-server" "oci_documentation_mcp_server/server.py"
```
