Skip to content

skill basic#1

Open
drorhilman wants to merge 3 commits intocodeocean:mainfrom
drorhilman:feature/codeocean-skill-setup
Open

skill basic#1
drorhilman wants to merge 3 commits intocodeocean:mainfrom
drorhilman:feature/codeocean-skill-setup

Conversation

@drorhilman
Copy link
Copy Markdown

No description provided.

Copy link
Copy Markdown
Contributor

@zvikagart zvikagart left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure this is the correct strategy for a code ocean skill.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The data model is very much version-dependant and the skill can easily drift from the actual system version a customer is using. It's also a debt to maintain.
Can we not point to user guide with a note to use the correct system version?

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The hardcoded field enumerations have been removed from all reference
files and replaced with instructions for agents to consult three runtime sources of truth: the live MCP
tool schemas (delivered at connection time), the installed SDK version, and the Code Ocean User Guide matching the customer's deployed version

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks like duplicating the mcp server readme

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is again very-much mcp server version dependant and just duplicates the mcp server tool list and description that an agent would be able to discover easily with the mcp server installed.

Comment thread codeocean/references/sdk-guide.md Outdated
Comment on lines +7 to +13
Compatibility note:

- Public docs currently say Python `>=3.11` and Code Ocean `>=2.19`
- Local `pyproject.toml` declares Python `>=3.9`
- Local client code sends `Min-Server-Version: 4.3.0`

Document the split instead of collapsing it.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a note to self rather than a skill

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed.

…uracy

- Updated capsules.md to streamline the data model section and clarify search parameters.
- Revised computations.md to enhance explanations of running computations and handling results.
- Simplified custom-metadata.md to focus on deployment-defined schemas and usage examples.
- Clarified data-assets.md by removing redundant data model details and emphasizing query syntax.
- Enhanced errors-http-and-sdk.md to provide clearer descriptions of SDK error handling.
- Improved errors-resource-states.md by summarizing key fields for computation and data asset failures.
- Updated mcp-guide.md to emphasize the importance of live schemas for tool parameters.
- Revised mcp-tools-catalog.md to clarify tool groupings and behavioral notes.
- Streamlined permissions.md to focus on available permissions in SDK and REST API.
- Updated pipelines.md to clarify the routing of pipeline operations through the SDK.
- Refined sdk-guide.md to emphasize the importance of inspecting the installed SDK version.
- Enhanced search-and-pagination.md to clarify query syntax and structured search parameters.
- Updated setup-and-auth.md to address compatibility discrepancies between SDK and MCP versions.
- The MCP tools named `get_capsule`, `get_capsule_app_panel`, `list_computations`, `attach_data_assets`, and `detach_data_assets` are implemented via `client.capsules.*`, not `client.pipelines.*`.
- Use SDK or REST when you need guaranteed `/pipelines/...` routing for pipeline inspection or management.

## Pagination and Compact Search
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This, again, repeats the mcp tool docstring.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants