An Model Context Protocol (MCP) server for OCI Documentation
Project description
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.
Features
- Read Documentation: Fetch and convert OCI documentation pages to markdown format
- Search Documentation: Search OCI documentation using search engine
Prerequisites
Installation Requirements
- Install
uvfrom Astral or the GitHub README - Install Python 3.10 or newer using
uv python install 3.10(or a more recent version)
Installation
To add this MCP server to your Amazon Q or Claude, add the following to your MCP config file. With Amazon Q, create (if does not yet exist) a file named .amazonq/mcp.json under the same directory that is running q chat. Then add the following config:
{
"mcpServers": {
"oci-documentation-mcp-server": {
"command": "uvx",
"args": ["oci-documentation-mcp-server@latest"],
"env": {
"FASTMCP_LOG_LEVEL": "ERROR"
},
"disabled": false,
"autoApprove": []
}
}
}
Basic Usage
Example:
- "look up documentation on Object bucket naming rule. cite your sources"
Tools
read_documentation
Fetches an OCI documentation page and converts it to markdown format.
read_documentation(url: str) -> str
search_documentation
Searches OCI documentation using the search engine.
search_documentation(search_phrase: str, limit: int) -> list[dict]
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file oci_documentation_mcp_server-0.0.1.tar.gz.
File metadata
- Download URL: oci_documentation_mcp_server-0.0.1.tar.gz
- Upload date:
- Size: 48.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a7828b75459da48105da1a710ff29ad48cc9ceb0d2b078abc5b4635dcfdd820f
|
|
| MD5 |
53f1693e205f8b1b297ab10c113f275b
|
|
| BLAKE2b-256 |
b1868820b23b3cdda5b654f7825cb48deda64b9acdef8c4d6362d5b79c9e524e
|
Provenance
The following attestation bundles were made for oci_documentation_mcp_server-0.0.1.tar.gz:
Publisher:
publish.yml on jin38324/oci-documentation-mcp-server
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
oci_documentation_mcp_server-0.0.1.tar.gz -
Subject digest:
a7828b75459da48105da1a710ff29ad48cc9ceb0d2b078abc5b4635dcfdd820f - Sigstore transparency entry: 199988148
- Sigstore integration time:
-
Permalink:
jin38324/oci-documentation-mcp-server@80dd75def1f3ec4a05ec2b8db1cd7bfed4b6f067 -
Branch / Tag:
refs/tags/v0.0.1 - Owner: https://github.com/jin38324
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@80dd75def1f3ec4a05ec2b8db1cd7bfed4b6f067 -
Trigger Event:
release
-
Statement type:
File details
Details for the file oci_documentation_mcp_server-0.0.1-py3-none-any.whl.
File metadata
- Download URL: oci_documentation_mcp_server-0.0.1-py3-none-any.whl
- Upload date:
- Size: 10.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8e62519be099f7d3a7e9381dffcc18bb5f1a8b0f368140f40a9562b804ef9ef2
|
|
| MD5 |
0ccba49040fe4eea25960d155bdff7e1
|
|
| BLAKE2b-256 |
ffef01749abc3ddd55eaa6a670f637f92975e25599a24ca2abb267ee1342300e
|
Provenance
The following attestation bundles were made for oci_documentation_mcp_server-0.0.1-py3-none-any.whl:
Publisher:
publish.yml on jin38324/oci-documentation-mcp-server
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
oci_documentation_mcp_server-0.0.1-py3-none-any.whl -
Subject digest:
8e62519be099f7d3a7e9381dffcc18bb5f1a8b0f368140f40a9562b804ef9ef2 - Sigstore transparency entry: 199988151
- Sigstore integration time:
-
Permalink:
jin38324/oci-documentation-mcp-server@80dd75def1f3ec4a05ec2b8db1cd7bfed4b6f067 -
Branch / Tag:
refs/tags/v0.0.1 - Owner: https://github.com/jin38324
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@80dd75def1f3ec4a05ec2b8db1cd7bfed4b6f067 -
Trigger Event:
release
-
Statement type: