-
Notifications
You must be signed in to change notification settings - Fork 78
feat: add help tool #111
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
feat: add help tool #111
Conversation
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.
Pull Request Overview
This PR adds a new help tool to provide users with guidance on using and troubleshooting the MCP server. Key changes include:
- Removing two integration tests related to actor query parameters and auto-loading.
- Adding a new help tool in the helpers module with its associated schema and behavior.
- Updating the server and constant files to include the new help tool in the default tool set.
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| tests/integration/actor.server.test.ts | Removed tests for query parameter-based actor loading and auto-loading flag. |
| src/tools/helpers.ts | Introduced the new help tool but with a schema inconsistency. |
| src/mcp/server.ts | Updated tool registration to include the new help tool. |
| src/const.ts | Added the help tool to the HelperTools enum and default helper tools list. |
Comments suppressed due to low confidence (1)
tests/integration/actor.server.test.ts:52
- The removal of integration tests for query parameters and auto-loading may reduce test coverage. Consider adding tests to verify the functionality of the new help tool integration.
it('should load actors from query parameters', async () => {
Co-authored-by: Copilot <[email protected]>
jirispilka
left a comment
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.
There were small changes here and there, so I decided to do an extra commit.
Looks good to me! I haven't tested it, though.
Co-authored-by: Jiří Spilka <[email protected]>
* add default tools stdio test * run unit only by default, add more stdio tests, fix concurrency in actor server tests * vibe unit tests * fix default tool loading for Actors MCP server, more integration tests * organize tests * add streamable Actor server tests, improve consistency with real setup * decouple actor mcp server helper funcs and actors mcp server main MCPServer class creation * add tests readme * rename streamable client * unify default tools loading * feat: add help tool (#111) * add help tool * Update src/tools/helpers.ts Co-authored-by: Copilot <[email protected]> * fix: move tool text into a constant * fix: helpTool text * Update src/tools/helpers.ts Co-authored-by: Jiří Spilka <[email protected]> --------- Co-authored-by: Copilot <[email protected]> Co-authored-by: Jiri Spilka <[email protected]> Co-authored-by: Jiří Spilka <[email protected]> * removed createActorMCPServer wrapper - using ActorsMCPServer class directly, removed duplicate tools.actor tests and renamed actor.test.ts, removed old TODOs * use single http server insteance for each describe clock and reset state for each state to fix MaxListenersExceededWarning * Update src/mcp/server.ts Co-authored-by: Copilot <[email protected]> * fix: actor -> Actor * refactor tests and create a shared test suite --------- Co-authored-by: Copilot <[email protected]> Co-authored-by: Jiri Spilka <[email protected]> Co-authored-by: Jiří Spilka <[email protected]>
This PR adds
help-toolthat returns a simple guide on how to use and troubleshoot issues with Apify MCP server