Update docs #63
Merged
Update docs #63
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* Add comprehensive OpenAPI ingestion documentation - Add detailed OpenAPI ingestion guide with 5 different methods - Include working code examples for all ingestion approaches - Add prominent OpenAPI section to main README - All code snippets tested and validated - Zero infrastructure approach highlighted * Simplify OpenAPI ingestion documentation - Remove unnecessary duplication and complexity - Focus on core functionality with minimal examples - Reduce from verbose guide to concise reference - All code snippets tested and working * Clarify plugin dependencies in OpenAPI documentation - Add plugin comments to all UTCP imports - Show which imports come from core vs utcp-http plugin - Clarify YAML loader also handles JSON files --------- Co-authored-by: Razvan Radulescu <[email protected]>
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
| @@ -588,8 +587,7 @@ async def call_tool(self, caller, tool_name: str, tool_args: Dict[str, Any], too | |||
| Returns: | |||
| The result of the command execution. If the command exits with a code | |||
| of 0, it returns the content of stdout. If the exit code is non-zero, | |||
| it returns the content of stderr. The output is parsed as JSON if | |||
| possible; otherwise, it is returned as a raw string. | |||
| it returns the content of stderr. | |||
There was a problem hiding this comment.
Docstring omits that successful stdout is parsed as JSON when possible; this line now misstates the function’s behavior, which returns parsed JSON via _parse_combined_output when the output looks like JSON.
Prompt for AI agents
Address the following comment on plugins/communication_protocols/cli/src/utcp_cli/cli_communication_protocol.py at line 590:
<comment>Docstring omits that successful stdout is parsed as JSON when possible; this line now misstates the function’s behavior, which returns parsed JSON via _parse_combined_output when the output looks like JSON.</comment>
<file context>
@@ -588,8 +587,7 @@ async def call_tool(self, caller, tool_name: str, tool_args: Dict[str, Any], too
of 0, it returns the content of stdout. If the exit code is non-zero,
- it returns the content of stderr. The output is parsed as JSON if
- possible; otherwise, it is returned as a raw string.
+ it returns the content of stderr.
Raises:
</file context>
Suggested change
| it returns the content of stderr. | |
| it returns the content of stderr. The output is parsed as JSON if possible; otherwise, it is returned as a raw string. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary by cubic
Adds a comprehensive OpenAPI ingestion guide and expands the README to show zero‑infrastructure conversion of OpenAPI 2.0/3.0 specs into UTCP tools using the utcp-http plugin and client config examples. Also clarifies CLI protocol docs (no implicit JSON parsing), marks CommandStep as REQUIRED in the CLI template, and tidies a test.