Skip to content

Conversation

@shopewf
Copy link
Member

@shopewf shopewf commented Oct 24, 2025

Description

The changes in this PR include a new best practices doc to explain a few of our general design guidelines.

Note: The changes in this PR are not currently all-encompassing, meaning once this gets reviewed and people like it, then I can apply those best practices to the rest of the repo. I dont want to do that first, then realize people dont like these changes and have to undo/redo them.

There are many small miscellaneous changes as well:

  • Changed default file location for mcphost mcp configuration file
  • Changed command to generate venv so that it works regardless of what your machine's default python3 version is
  • Updated some of the compute server to match the best practices doc (if the best practices doc gets the go-ahead, I'll apply the changes everywhere in the compute server)
  • Updated the generic APIs docstring. I noticed there were a lot of errors because it was trying to make complex queries using the --data flag, which would then cause the query to fail. It would fail a few more times afterward before it would call the help tool, and then get the query correct. I wanted to avoid that frustration, so I asked it to avoid those complex query flags, and if it needed them to first call the help tool so it didnt get things wrong multiple times in a row

Please test this with mcphost as well, not just Cline

Fixes # (issue)

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

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

  • Reran all compute MCP tools with Cline
  • Reran all compute MCP tools with mcphost

Test Configuration:

  • Firmware version:
  • Hardware:
  • Toolchain:
  • SDK:

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

@oracle-contributor-agreement oracle-contributor-agreement bot added the OCA Verified All contributors have signed the Oracle Contributor Agreement. label Oct 24, 2025
@shopewf shopewf force-pushed the wshope/best-practices branch from f15418d to 2bc9c5d Compare October 24, 2025 18:53
@shopewf shopewf force-pushed the wshope/best-practices branch 2 times, most recently from 9b36b5e to 2d28d93 Compare October 24, 2025 20:57
@shopewf shopewf force-pushed the wshope/best-practices branch 2 times, most recently from 6b05fb2 to 89992b2 Compare October 28, 2025 18:55
@shopewf shopewf force-pushed the wshope/best-practices branch 2 times, most recently from 153778b to d8abbc3 Compare October 29, 2025 19:13
@shopewf shopewf force-pushed the wshope/best-practices branch 2 times, most recently from 076b9e2 to db81704 Compare October 30, 2025 18:15
@shopewf shopewf requested a review from gebhardtr October 30, 2025 21:39
@shopewf shopewf force-pushed the wshope/best-practices branch from db81704 to 9ab9a2f Compare October 30, 2025 23:22
gebhardtr
gebhardtr previously approved these changes Oct 30, 2025
Signed-off-by: will.shope <[email protected]>
@gebhardtr gebhardtr merged commit a04bce9 into oracle:main Oct 30, 2025
16 checks passed
@gebhardtr gebhardtr deleted the wshope/best-practices branch October 30, 2025 23:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

OCA Verified All contributors have signed the Oracle Contributor Agreement.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants