Skip to content

Commit 03599c0

Browse files
authored
Merge pull request #3195 from oracle-devrel/lsa/mcp-blueprint
added oci-mcp-blueprint
2 parents ab022ab + abc9444 commit 03599c0

1 file changed

Lines changed: 106 additions & 0 deletions

File tree

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
# OCI MCP Blueprint
2+
3+
This asset is a blueprint for building, customizing, packaging, and deploying a
4+
Python MCP server on Oracle Cloud Infrastructure.
5+
6+
It provides a practical starting point for teams that want to move from a local
7+
custom MCP server prototype to a cloud-ready service deployable on OCI
8+
Enterprise AI Hosted Applications, with a clear protocol boundary, modular
9+
sample code, local validation clients, and a guided deployment factory.
10+
11+
Key features:
12+
13+
- 🔌 Python FastMCP server using Streamable HTTP.
14+
- 🧰 Two sample MCP tools, `get_schema` and `get_data`, backed by fake
15+
hard-coded database metadata and simulated rows.
16+
- 🧩 Modular domain and MCP registration layers for replacing the sample tools
17+
with a custom MCP implementation.
18+
- 🖥️ Command-line MCP client for local and remote endpoint validation.
19+
- 🐳 Docker Compose deployment for running the MCP server locally in one
20+
container.
21+
- 🏭 OCI Hosted Deployment Factory for building the server image, pushing it to
22+
OCIR, and creating an OCI Enterprise AI Hosted Application deployment.
23+
- 🧪 Specifications, tests, and documentation for repeatable, reviewable
24+
evolution.
25+
26+
## Link to the original repo
27+
28+
[https://github.com/luigisaetta/oci-mcp-blueprint](https://github.com/luigisaetta/oci-mcp-blueprint)
29+
30+
Author: L. Saetta
31+
32+
Reviewed: 08.07.2026
33+
34+
## Who should use this asset
35+
36+
Use this asset if you want to prototype, validate, or bootstrap a custom MCP
37+
server in Python and deploy it on OCI Enterprise AI Hosted Applications.
38+
39+
It is intended for architects, developers, and field teams who need a reusable
40+
starting point for exposing custom tools through an MCP server contract that can
41+
be tested locally, packaged as a container, and promoted to OCI.
42+
43+
## When to use this asset?
44+
45+
Use this asset when you need to:
46+
47+
- Build a Python MCP server with a clean FastMCP Streamable HTTP boundary.
48+
- Replace sample tools with custom business, data, or integration tools.
49+
- Validate MCP tool discovery and tool calls locally with a command-line client.
50+
- Package the MCP server as a Docker image.
51+
- Run the server locally through Python or Docker Compose.
52+
- Deploy the MCP server to OCI Enterprise AI Hosted Applications through a
53+
guided local factory.
54+
- Use a blueprint that includes specifications, tests, configuration notes,
55+
customization guidance, and operational documentation.
56+
57+
You should not use this asset:
58+
59+
- As a drop-in production service without reviewing security, IAM,
60+
observability, scaling, deployment, and operational requirements for your
61+
environment.
62+
- When you only need a one-off local script without an MCP server boundary.
63+
- When you need protocols other than MCP Streamable HTTP.
64+
- When you need an unrelated deployment target or framework outside the
65+
Python-MCP-on-OCI scope.
66+
67+
In short: this asset accelerates learning, prototyping, and implementation of
68+
custom MCP servers on OCI while keeping the architecture explicit, testable, and
69+
easy to adapt.
70+
71+
# How to use this asset?
72+
73+
Start from the main repository README and follow the local setup instructions:
74+
75+
- Repository:
76+
[oci-mcp-blueprint](https://github.com/luigisaetta/oci-mcp-blueprint)
77+
- Main README:
78+
[README.md](https://github.com/luigisaetta/oci-mcp-blueprint/blob/main/README.md)
79+
- MCP customization guide:
80+
[docs/customizing-mcp-server.md](https://github.com/luigisaetta/oci-mcp-blueprint/blob/main/docs/customizing-mcp-server.md)
81+
- Docker Compose deployment:
82+
[docs/docker-compose-deployment.md](https://github.com/luigisaetta/oci-mcp-blueprint/blob/main/docs/docker-compose-deployment.md)
83+
- OCI Hosted Deployment Factory:
84+
[docs/oci-hosted-deployment-factory.md](https://github.com/luigisaetta/oci-mcp-blueprint/blob/main/docs/oci-hosted-deployment-factory.md)
85+
- Specifications:
86+
[specs/](https://github.com/luigisaetta/oci-mcp-blueprint/tree/main/specs)
87+
88+
Typical usage flow:
89+
90+
1. Create or activate the `oci-mcp-blueprint` Conda environment.
91+
2. Install the project locally with development dependencies.
92+
3. Start the sample MCP server with FastMCP Streamable HTTP.
93+
4. Validate tool discovery with `oci-mcp-blueprint-client list-tools`.
94+
5. Call the sample `get_schema` and `get_data` tools.
95+
6. Replace the fake domain logic and MCP tool registrations with your custom
96+
implementation.
97+
7. Run tests and local Docker Compose validation.
98+
8. Start the OCI Hosted Deployment Factory when you are ready to build, push,
99+
and deploy the MCP server image to OCI Enterprise AI Hosted Applications.
100+
9. Adapt security, IAM, observability, scaling, and operations to your OCI
101+
environment before production use.
102+
103+
## License
104+
105+
Licensed under the MIT license. See
106+
[LICENSE](https://github.com/luigisaetta/oci-mcp-blueprint/blob/main/LICENSE).

0 commit comments

Comments
 (0)