Skip to content

Improve wording of AI agent descriptions #15397

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

mvtec-richter
Copy link
Contributor

What it does

Improve the description of the AI agents. The description could be more user focused.

Also fix minor issues in the AI welcome text.

How to test

  • Review the description of the AI agents

Follow-ups

Breaking changes

  • This PR introduces breaking changes and requires careful review. If yes, the breaking changes section in the changelog has been updated.

Attribution

Contributed by MVTec Software GmbH

Review checklist

Reminder for reviewers

* The description is user visible and can address the user
* Fix spelling in AI welcome message

Signed-off-by: Florian Richter <[email protected]>
@github-project-automation github-project-automation bot moved this to Waiting on reviewers in PR Backlog Apr 4, 2025
@JonasHelming JonasHelming self-requested a review April 4, 2025 13:57
@JonasHelming
Copy link
Contributor

Thank you for the contribution.
In general you change two things generically:

  • Say "you" rather than "the user"
  • Remove all references to the Theia IDE

I see a general two potential issues here:

  1. These descriptions are used by the Orchestrator to delegate to the best agent. For this use case, referring to "the user" might make more sense.

Could you elaborate why this changes is necessary for your use case?

  1. Also for this use case, keeping the references to the actual tool makes probably more sense. While it might not play a role for most agents, for example for the command agent it could.

For example by removing "This agent is aware of all commands that the user can execute within the Theia IDE, the tool that the user is currently working with"

the Orchestrator might have issues with prompt like:

  • "Change the color schema of Theia"
  • "Open the Theia settings"
    or potentially even
  • Change the color schema (as we remove the last part of the sentence)

Another issue might be that you might need to review and adapt this for any new release, as we have currently no guard or check that a future commit does not introduce "Theia IDE" again.

At the moment, the agents in the IDE package are targeted at the Theia IDE, but it would be of course great, if they could be reused with reasonable effort. This would be already possible today by using the string translation mechanism to replace the description Strings.

If you end up only adapting the tools name, nothing else (expect of course improvements also valid for the Theia IDE), we might also consider to make "Theia IDE" a global variable, so it can be replaced in one shot. This depends my question above, though.

Before discussing the Strings adapted in this PR, I think it makes sense to align this first, WDYT?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Waiting on reviewers
Development

Successfully merging this pull request may close these issues.

2 participants