iflow-mcp_jin38324_oci-documentation-mcp-server 0.0.1__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- iflow_mcp_jin38324_oci_documentation_mcp_server-0.0.1/.gitattributes +2 -0
- iflow_mcp_jin38324_oci_documentation_mcp_server-0.0.1/.github/workflows/publish.yml +42 -0
- iflow_mcp_jin38324_oci_documentation_mcp_server-0.0.1/.gitignore +61 -0
- iflow_mcp_jin38324_oci_documentation_mcp_server-0.0.1/.pre-commit-config.yaml +14 -0
- iflow_mcp_jin38324_oci_documentation_mcp_server-0.0.1/.python-version +1 -0
- iflow_mcp_jin38324_oci_documentation_mcp_server-0.0.1/3025_process.log +3 -0
- iflow_mcp_jin38324_oci_documentation_mcp_server-0.0.1/CHANGELOG.md +14 -0
- iflow_mcp_jin38324_oci_documentation_mcp_server-0.0.1/LICENSE +21 -0
- iflow_mcp_jin38324_oci_documentation_mcp_server-0.0.1/PKG-INFO +108 -0
- iflow_mcp_jin38324_oci_documentation_mcp_server-0.0.1/README.md +93 -0
- iflow_mcp_jin38324_oci_documentation_mcp_server-0.0.1/image/Cursor_MCP.gif +0 -0
- iflow_mcp_jin38324_oci_documentation_mcp_server-0.0.1/language.json +1 -0
- iflow_mcp_jin38324_oci_documentation_mcp_server-0.0.1/oci_documentation_mcp_server/__init__.py +11 -0
- iflow_mcp_jin38324_oci_documentation_mcp_server-0.0.1/oci_documentation_mcp_server/models.py +19 -0
- iflow_mcp_jin38324_oci_documentation_mcp_server-0.0.1/oci_documentation_mcp_server/server.py +299 -0
- iflow_mcp_jin38324_oci_documentation_mcp_server-0.0.1/oci_documentation_mcp_server/util.py +189 -0
- iflow_mcp_jin38324_oci_documentation_mcp_server-0.0.1/package_name +1 -0
- iflow_mcp_jin38324_oci_documentation_mcp_server-0.0.1/push_info.json +5 -0
- iflow_mcp_jin38324_oci_documentation_mcp_server-0.0.1/pyproject.toml +98 -0
- iflow_mcp_jin38324_oci_documentation_mcp_server-0.0.1/test_mcp.py +65 -0
- iflow_mcp_jin38324_oci_documentation_mcp_server-0.0.1/uv.lock +1052 -0
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
name: Publish Python Package to PyPI on Release
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
release:
|
|
5
|
+
types: [created]
|
|
6
|
+
|
|
7
|
+
jobs:
|
|
8
|
+
publish-to-pypi:
|
|
9
|
+
name: Build and Publish
|
|
10
|
+
runs-on: ubuntu-latest
|
|
11
|
+
permissions:
|
|
12
|
+
# 仅允许写入 GitHub 的 id-token(用于 OIDC,如需要)
|
|
13
|
+
id-token: write
|
|
14
|
+
# 仅允许读取 secrets.PYPI_TOKEN
|
|
15
|
+
contents: read
|
|
16
|
+
environment:
|
|
17
|
+
name: pypi
|
|
18
|
+
url: https://pypi.org/p/oci-documentation-mcp-server
|
|
19
|
+
|
|
20
|
+
steps:
|
|
21
|
+
- name: Checkout code
|
|
22
|
+
uses: actions/checkout@v4
|
|
23
|
+
|
|
24
|
+
- name: Set up Python
|
|
25
|
+
uses: actions/setup-python@v4
|
|
26
|
+
with:
|
|
27
|
+
python-version: "3.x"
|
|
28
|
+
|
|
29
|
+
- name: Upgrade build tools
|
|
30
|
+
run: |
|
|
31
|
+
python -m pip install --upgrade pip
|
|
32
|
+
|
|
33
|
+
- name: Install build backend
|
|
34
|
+
run: |
|
|
35
|
+
pip install build
|
|
36
|
+
|
|
37
|
+
- name: Build distributions
|
|
38
|
+
# 这里自动从 pyproject.toml 读取配置,生成 sdist + wheel
|
|
39
|
+
run: |
|
|
40
|
+
python -m build --sdist --wheel
|
|
41
|
+
- name: Publish to PyPI
|
|
42
|
+
uses: pypa/gh-action-pypi-publish@release/v1
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
# Python
|
|
2
|
+
__pycache__/
|
|
3
|
+
*.py[cod]
|
|
4
|
+
*$py.class
|
|
5
|
+
*.so
|
|
6
|
+
.Python
|
|
7
|
+
build/
|
|
8
|
+
develop-eggs/
|
|
9
|
+
dist/
|
|
10
|
+
downloads/
|
|
11
|
+
eggs/
|
|
12
|
+
.eggs/
|
|
13
|
+
lib/
|
|
14
|
+
lib64/
|
|
15
|
+
parts/
|
|
16
|
+
sdist/
|
|
17
|
+
var/
|
|
18
|
+
wheels/
|
|
19
|
+
share/python-wheels/
|
|
20
|
+
*.egg-info/
|
|
21
|
+
.installed.cfg
|
|
22
|
+
*.egg
|
|
23
|
+
MANIFEST
|
|
24
|
+
|
|
25
|
+
# Virtual environments
|
|
26
|
+
.venv
|
|
27
|
+
env/
|
|
28
|
+
venv/
|
|
29
|
+
ENV/
|
|
30
|
+
|
|
31
|
+
# IDE
|
|
32
|
+
.idea/
|
|
33
|
+
.vscode/
|
|
34
|
+
*.swp
|
|
35
|
+
*.swo
|
|
36
|
+
|
|
37
|
+
# Testing
|
|
38
|
+
.tox/
|
|
39
|
+
.coverage
|
|
40
|
+
.coverage.*
|
|
41
|
+
htmlcov/
|
|
42
|
+
.pytest_cache/
|
|
43
|
+
tests/
|
|
44
|
+
dev/
|
|
45
|
+
|
|
46
|
+
# Ruff
|
|
47
|
+
.ruff_cache/
|
|
48
|
+
|
|
49
|
+
# Build
|
|
50
|
+
*.manifest
|
|
51
|
+
*.spec
|
|
52
|
+
.pybuilder/
|
|
53
|
+
target/
|
|
54
|
+
|
|
55
|
+
# Environments
|
|
56
|
+
.env
|
|
57
|
+
.env.local
|
|
58
|
+
.env.*.local
|
|
59
|
+
|
|
60
|
+
# PyPI
|
|
61
|
+
.pypirc
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
repos:
|
|
2
|
+
- repo: https://github.com/astral-sh/ruff-pre-commit
|
|
3
|
+
rev: v0.9.6
|
|
4
|
+
hooks:
|
|
5
|
+
- id: ruff
|
|
6
|
+
args: [--fix]
|
|
7
|
+
- id: ruff-format
|
|
8
|
+
|
|
9
|
+
- repo: https://github.com/commitizen-tools/commitizen
|
|
10
|
+
rev: v3.13.0
|
|
11
|
+
hooks:
|
|
12
|
+
- id: commitizen
|
|
13
|
+
- id: commitizen-branch
|
|
14
|
+
stages: [pre-push]
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
3.13
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
All notable changes to this project will be documented in this file.
|
|
4
|
+
|
|
5
|
+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
6
|
+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
7
|
+
|
|
8
|
+
## [0.0.1] - 2025-04-21
|
|
9
|
+
|
|
10
|
+
First release.
|
|
11
|
+
|
|
12
|
+
### Added
|
|
13
|
+
|
|
14
|
+
- Initial project setup
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 jin
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: iflow-mcp_jin38324_oci-documentation-mcp-server
|
|
3
|
+
Version: 0.0.1
|
|
4
|
+
Summary: An Model Context Protocol (MCP) server for OCI Documentation
|
|
5
|
+
License-File: LICENSE
|
|
6
|
+
Requires-Python: >=3.10
|
|
7
|
+
Requires-Dist: beautifulsoup4>=4.12.0
|
|
8
|
+
Requires-Dist: googlesearch-python>=1.3.0
|
|
9
|
+
Requires-Dist: httpx>=0.27.0
|
|
10
|
+
Requires-Dist: loguru>=0.7.0
|
|
11
|
+
Requires-Dist: markdownify>=1.1.0
|
|
12
|
+
Requires-Dist: mcp[cli]>=1.6.0
|
|
13
|
+
Requires-Dist: pydantic>=2.10.6
|
|
14
|
+
Description-Content-Type: text/markdown
|
|
15
|
+
|
|
16
|
+
*Inspired by: https://github.com/awslabs/mcp/tree/main/src/aws-documentation-mcp-server*
|
|
17
|
+
|
|
18
|
+
# OCI Documentation MCP Server
|
|
19
|
+
|
|
20
|
+
Model Context Protocol (MCP) server for OCI Documentation
|
|
21
|
+
|
|
22
|
+
This MCP server provides tools to search for content, and access OCI documentation.
|
|
23
|
+
|
|
24
|
+
## Features
|
|
25
|
+
|
|
26
|
+
- **Read Documentation**: Fetch and convert OCI documentation pages to markdown format
|
|
27
|
+
- **Search Documentation**: Search OCI documentation using search engine
|
|
28
|
+
|
|
29
|
+
## Prerequisites
|
|
30
|
+
|
|
31
|
+
### Installation Requirements
|
|
32
|
+
|
|
33
|
+
1. Install `uv` from [Astral](https://docs.astral.sh/uv/getting-started/installation/) or the [GitHub README](https://github.com/astral-sh/uv#installation)
|
|
34
|
+
2. Install Python 3.10 or newer using `uv python install 3.10` (or a more recent version)
|
|
35
|
+
|
|
36
|
+
## Installation
|
|
37
|
+
|
|
38
|
+
MCP config:
|
|
39
|
+
|
|
40
|
+
```json
|
|
41
|
+
{
|
|
42
|
+
"mcpServers": {
|
|
43
|
+
"oci-documentation-mcp-server": {
|
|
44
|
+
"command": "uvx",
|
|
45
|
+
"args": [
|
|
46
|
+
"--from",
|
|
47
|
+
"oci-documentation-mcp-server@latest",
|
|
48
|
+
"python",
|
|
49
|
+
"-m",
|
|
50
|
+
"oci_documentation_mcp_server.server"
|
|
51
|
+
],
|
|
52
|
+
"env": {
|
|
53
|
+
"FASTMCP_LOG_LEVEL": "ERROR"
|
|
54
|
+
},
|
|
55
|
+
"disabled": false,
|
|
56
|
+
"autoApprove": []
|
|
57
|
+
},
|
|
58
|
+
}
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
If above doesn't work, try below one:
|
|
65
|
+
|
|
66
|
+
```json
|
|
67
|
+
{
|
|
68
|
+
"mcpServers": {
|
|
69
|
+
"oci-documentation-mcp-server": {
|
|
70
|
+
"command": "uvx",
|
|
71
|
+
"args": ["oci-documentation-mcp-server@latest"],
|
|
72
|
+
"env": {
|
|
73
|
+
"FASTMCP_LOG_LEVEL": "ERROR"
|
|
74
|
+
},
|
|
75
|
+
"disabled": false,
|
|
76
|
+
"autoApprove": []
|
|
77
|
+
}
|
|
78
|
+
}
|
|
79
|
+
}
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
## Basic Usage
|
|
83
|
+
Example:
|
|
84
|
+
- In Cursor ask: `Write a function to download files for OCI Object Storage.`
|
|
85
|
+
|
|
86
|
+

|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
## Tools
|
|
93
|
+
|
|
94
|
+
### read_documentation
|
|
95
|
+
|
|
96
|
+
Fetches an OCI documentation page and converts it to markdown format.
|
|
97
|
+
|
|
98
|
+
```python
|
|
99
|
+
read_documentation(url: str) -> str
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
### search_documentation
|
|
103
|
+
|
|
104
|
+
Searches OCI documentation using the search engine.
|
|
105
|
+
|
|
106
|
+
```python
|
|
107
|
+
search_documentation(search_phrase: str, limit: int) -> list[dict]
|
|
108
|
+
```
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
*Inspired by: https://github.com/awslabs/mcp/tree/main/src/aws-documentation-mcp-server*
|
|
2
|
+
|
|
3
|
+
# OCI Documentation MCP Server
|
|
4
|
+
|
|
5
|
+
Model Context Protocol (MCP) server for OCI Documentation
|
|
6
|
+
|
|
7
|
+
This MCP server provides tools to search for content, and access OCI documentation.
|
|
8
|
+
|
|
9
|
+
## Features
|
|
10
|
+
|
|
11
|
+
- **Read Documentation**: Fetch and convert OCI documentation pages to markdown format
|
|
12
|
+
- **Search Documentation**: Search OCI documentation using search engine
|
|
13
|
+
|
|
14
|
+
## Prerequisites
|
|
15
|
+
|
|
16
|
+
### Installation Requirements
|
|
17
|
+
|
|
18
|
+
1. Install `uv` from [Astral](https://docs.astral.sh/uv/getting-started/installation/) or the [GitHub README](https://github.com/astral-sh/uv#installation)
|
|
19
|
+
2. Install Python 3.10 or newer using `uv python install 3.10` (or a more recent version)
|
|
20
|
+
|
|
21
|
+
## Installation
|
|
22
|
+
|
|
23
|
+
MCP config:
|
|
24
|
+
|
|
25
|
+
```json
|
|
26
|
+
{
|
|
27
|
+
"mcpServers": {
|
|
28
|
+
"oci-documentation-mcp-server": {
|
|
29
|
+
"command": "uvx",
|
|
30
|
+
"args": [
|
|
31
|
+
"--from",
|
|
32
|
+
"oci-documentation-mcp-server@latest",
|
|
33
|
+
"python",
|
|
34
|
+
"-m",
|
|
35
|
+
"oci_documentation_mcp_server.server"
|
|
36
|
+
],
|
|
37
|
+
"env": {
|
|
38
|
+
"FASTMCP_LOG_LEVEL": "ERROR"
|
|
39
|
+
},
|
|
40
|
+
"disabled": false,
|
|
41
|
+
"autoApprove": []
|
|
42
|
+
},
|
|
43
|
+
}
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
If above doesn't work, try below one:
|
|
50
|
+
|
|
51
|
+
```json
|
|
52
|
+
{
|
|
53
|
+
"mcpServers": {
|
|
54
|
+
"oci-documentation-mcp-server": {
|
|
55
|
+
"command": "uvx",
|
|
56
|
+
"args": ["oci-documentation-mcp-server@latest"],
|
|
57
|
+
"env": {
|
|
58
|
+
"FASTMCP_LOG_LEVEL": "ERROR"
|
|
59
|
+
},
|
|
60
|
+
"disabled": false,
|
|
61
|
+
"autoApprove": []
|
|
62
|
+
}
|
|
63
|
+
}
|
|
64
|
+
}
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
## Basic Usage
|
|
68
|
+
Example:
|
|
69
|
+
- In Cursor ask: `Write a function to download files for OCI Object Storage.`
|
|
70
|
+
|
|
71
|
+

|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
## Tools
|
|
78
|
+
|
|
79
|
+
### read_documentation
|
|
80
|
+
|
|
81
|
+
Fetches an OCI documentation page and converts it to markdown format.
|
|
82
|
+
|
|
83
|
+
```python
|
|
84
|
+
read_documentation(url: str) -> str
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
### search_documentation
|
|
88
|
+
|
|
89
|
+
Searches OCI documentation using the search engine.
|
|
90
|
+
|
|
91
|
+
```python
|
|
92
|
+
search_documentation(search_phrase: str, limit: int) -> list[dict]
|
|
93
|
+
```
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
python
|
iflow_mcp_jin38324_oci_documentation_mcp_server-0.0.1/oci_documentation_mcp_server/__init__.py
ADDED
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance
|
|
2
|
+
# with the License. A copy of the License is located at
|
|
3
|
+
#
|
|
4
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
5
|
+
#
|
|
6
|
+
# or in the 'license' file accompanying this file. This file is distributed on an 'AS IS' BASIS, WITHOUT WARRANTIES
|
|
7
|
+
# OR CONDITIONS OF ANY KIND, express or implied. See the License for the specific language governing permissions
|
|
8
|
+
# and limitations under the License.
|
|
9
|
+
"""oci-documentation-mcp-server"""
|
|
10
|
+
|
|
11
|
+
__version__ = '0.0.1'
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance
|
|
2
|
+
# with the License. A copy of the License is located at
|
|
3
|
+
#
|
|
4
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
5
|
+
#
|
|
6
|
+
# or in the 'license' file accompanying this file. This file is distributed on an 'AS IS' BASIS, WITHOUT WARRANTIES
|
|
7
|
+
# OR CONDITIONS OF ANY KIND, express or implied. See the License for the specific language governing permissions
|
|
8
|
+
# and limitations under the License.
|
|
9
|
+
"""Data models for OCI Documentation MCP Server."""
|
|
10
|
+
|
|
11
|
+
from pydantic import BaseModel
|
|
12
|
+
from typing import Optional
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
class SearchResult(BaseModel):
|
|
16
|
+
"""Search result from OCI documentation search."""
|
|
17
|
+
title: str
|
|
18
|
+
url: str
|
|
19
|
+
description: Optional[str] = None
|