-
Notifications
You must be signed in to change notification settings - Fork 2.6k
vscode extension tool interface #2851
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| ## Extension Tool API | ||
|
|
||
| Roo now provides an API for VSCode extensions to register custom tools that can be used by Roo. This allows other extensions to extend Roo's capabilities without modifying the Roo codebase. | ||
|
|
||
| ### Using the Extension Tool API | ||
|
|
||
| To use the Extension Tool API, your extension needs to: | ||
|
|
||
| 1. Add `RooVeterinaryInc.roo-cline` as an extension dependency in your `package.json`. | ||
| 2. Get the Roo extension API and access the `extensionTools` property. | ||
| 3. Register your tools using the `registerTool` method. | ||
|
|
||
| Here's a simple example: | ||
|
|
||
| ```typescript | ||
| // Access the Roo extension | ||
| const rooExtension = vscode.extensions.getExtension<RooAPI>("RooVeterinaryInc.roo-cline") | ||
|
|
||
| if (rooExtension && rooExtension.exports.extensionTools) { | ||
| // Register a tool | ||
| rooExtension.exports.extensionTools.registerTool(context.extension.id, { | ||
| name: "my_tool", | ||
| description: "Description of what the tool does", | ||
| inputSchema: { | ||
| // Optional JSON schema for tool arguments | ||
| type: "object", | ||
| properties: { | ||
| myArg: { | ||
| type: "string", | ||
| description: "Description of the argument", | ||
| }, | ||
| }, | ||
| }, | ||
| execute: async (args) => { | ||
| // Implement your tool functionality | ||
| return { | ||
| content: [ | ||
| { | ||
| type: "text", | ||
| text: "Result of the tool execution", | ||
| }, | ||
| ], | ||
| } | ||
| }, | ||
| }) | ||
| } | ||
| ``` | ||
|
|
||
| ### Tool Response Format | ||
|
|
||
| Tools return responses in the same format as MCP tools: | ||
|
|
||
| ```typescript | ||
| { | ||
| content: [ | ||
| { | ||
| type: 'text', | ||
| text: 'Text content' | ||
| } | ||
| // Can also include resources | ||
| ], | ||
| isError?: boolean // Optional flag to indicate if the tool execution failed | ||
| } | ||
| ``` | ||
|
|
||
| ### Example Extension | ||
|
|
||
| See the [Roo-NB](https://github.com/RooVeterinaryInc/Roo-NB) extension for a complete example of a tool provider extension. |
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| import { ExtensionToolManager } from "../../../services/extensions/ExtensionToolManager" | ||
|
|
||
| /** | ||
| * Generates the section of the system prompt that describes available extension tools | ||
| */ | ||
| export async function getExtToolsSection(extensionToolManager?: ExtensionToolManager): Promise<string> { | ||
| // If no manager is provided, get the singleton instance | ||
| if (!extensionToolManager) { | ||
| try { | ||
| extensionToolManager = await ExtensionToolManager.getInstance() | ||
| } catch (error) { | ||
| console.error("Failed to get ExtensionToolManager:", error) | ||
| return "" | ||
| } | ||
| } | ||
|
|
||
| // Get all registered tools | ||
| const allTools = extensionToolManager.getAllTools() | ||
|
|
||
| if (allTools.length === 0) { | ||
| return "" | ||
| } | ||
|
|
||
| // Group tools by extension | ||
| const extensionTools: Record<string, string[]> = {} | ||
|
|
||
| for (const { extensionId, tool } of allTools) { | ||
| if (!extensionTools[extensionId]) { | ||
| extensionTools[extensionId] = [] | ||
| } | ||
|
|
||
| extensionTools[extensionId].push(`${tool.name}: ${tool.description}`) | ||
| } | ||
|
|
||
| let result = "# Available Extension Tools\n\n" | ||
|
|
||
| for (const [extensionId, tools] of Object.entries(extensionTools)) { | ||
| result += `## Extension: ${extensionId}\n\n` | ||
|
|
||
| for (const toolDesc of tools) { | ||
| result += `- ${toolDesc}\n` | ||
| } | ||
|
|
||
| result += "\n" | ||
| } | ||
|
|
||
| return result | ||
| } |
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This error message formatter duplicates the existing
invalidMcpToolArgumentError. Consider consolidating these into a single function.invalidMcpToolArgumentError(responses.ts)This comment was generated because it violated a code review rule: mrule_fYE6mUdYYxZL58YF.