[CHORE] Update readme for PyPi packages #32
Conversation
oracle-contributor-agreement
bot
added
the
OCA Verified
README.md
Outdated
| git clone https://github.com/oracle/mcp.git | ||
| cd mcp | ||
| ``` | ||
| Follow these instructions to get started as quickly as possible. Once finished, look [here](#local-development) to set up your local development environment if you wish to [contribute](#contributing) code changes. |
|
|
||
| For OCI MCP servers, you'll need to install and authenticate using the OCI CLI. | ||
|
|
||
| 1. Install the [OCI CLI](https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/cliinstall.htm) |
There was a problem hiding this comment.
Should we point the users to https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/clitoken.htm
I am asking because some of the MCP servers that we currently have (db-tools..) do not use oci session authenticate and will actually not work with token-based authentication. It still relies on API key and user-based authentication
There was a problem hiding this comment.
What you sent is still documentation for token-based authentication, no?
Or are you saying that the db-tools server requires token-based authentication? The wording here is tripping me up a bit
Also, if there is one server that has specific auth requirements, shouldnt that just go in its specific readme instead?
There was a problem hiding this comment.
That document talks about both. https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/clitoken.htm#clitoken_topic-Starting_a_Tokenbased_CLI_Session_No_Browser has the information on API key-based signing
The db-tools mcp server will not work if you have authenticated the OCI CLI using session authencation. That is a change that I will be submitting soon
What I was thinking was we point to the doc, so if CLI decides to change the auth mechanism, we won't have to in our README. They (CLI) will keep that doc relevant at all times.
There was a problem hiding this comment.
I believe we still at least need that cli install link there as that one is just for installing the oci cli in general.
Maybe we can find somewhere else to include that link youve sent
shopewf
force-pushed
the
wshope/update-readme-with-pypi-packages
branch
2 times, most recently
from
0fb5da2 to
1c765a6
Compare
README.md
Outdated
| ``` | ||
| 1. Install `uv` from [here](https://docs.astral.sh/uv/getting-started/installation/) | ||
| 2. Install python with `uv python install 3.13` | ||
| 3. Configure [OCI authentication](#authentication) |
There was a problem hiding this comment.
this is only for the OCI servers; something like?
| 3. Configure [OCI authentication](#authentication) | |
| 3. (for OCI MCP servers) Configure [OCI authentication](#authentication) |
Signed-off-by: will.shope <will.shope@oracle.com>
shopewf
force-pushed
the
wshope/update-readme-with-pypi-packages
branch
from
1c765a6 to
c7e07ab
Compare
Signed-off-by: will.shope <will.shope@oracle.com>
4 participants
Description
This PR includes updates to the readme to account for the new artifacts being pushed to PyPi. The getting started section has now been much more simplified, and a new section for local dev work has been added for the case where people dont want to use the PyPi artifacts
Also fixes a lot of small issues with the readme's markdown that was not working as intended.
Type of change
Please delete options that are not relevant.
How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
Checklist: