Add @ts-ignore to @modelcontextprotocol/sdk type
#181
Merged
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
There was a problem hiding this comment.
Pull Request Overview
This pull request enhances documentation and code examples for the Agentica library while improving type safety and developer awareness for the MCP client interface through a dependency warning.
- Updated the README with clearer, more motivational content and revised code examples for AI agent development.
- Introduced a dependency warning and a temporary workaround (using @ts-ignore) in the IMcpLlmController interface to handle missing type validation when @modelcontextprotocol/sdk is not installed.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| src/structures/IMcpLlmController.ts | Added dependency warning with explanatory documentation and a @ts-ignore annotation for the client property |
| README.md | Revamped content and updated code examples to support a clearer understanding of Agentica’s usage |
Comment on lines
+86
to
87
| // @ts-ignore | ||
| client: import("@modelcontextprotocol/sdk/client/index.d.ts").Client; |
There was a problem hiding this comment.
[nitpick] The use of '@ts-ignore' suppresses valuable TypeScript error hints; consider adding an inline comment specifying the exact error being bypassed or exploring an alternative solution for more robust type handling.
Suggested change
| // @ts-ignore | |
| client: import("@modelcontextprotocol/sdk/client/index.d.ts").Client; | |
| /** | |
| * MCP client for connection. | |
| * | |
| * This type will resolve to `any` if the `@modelcontextprotocol/sdk` package | |
| * is not installed. Ensure the package is installed to use the proper type. | |
| */ | |
| client: import("@modelcontextprotocol/sdk/client/index.d.ts").Client | any; |
Copilot uses AI. Check for mistakes.
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.
This pull request introduces significant updates to the
agenticalibrary documentation and code examples, as well as a type-related enhancement in theIMcpLlmControllerinterface. The key changes include a revamped README for improved clarity and accessibility, and a new dependency warning in the TypeScript interface definition.Documentation and Code Example Updates:
agentica, emphasizing its ease of use for AI agent development with clear examples of supported protocols (TypeScript Class, Swagger/OpenAPI, MCP). Added a motivational section targeting TypeScript and backend developers to highlight their readiness for AI development.MobileFileSystemas a TypeScript class example and added a newvendorconfiguration for specifying the AI model (gpt-4o-mini) and API key. Also replaced outdatedtypia.llm.applicationcalls with updatedtypia.llm.controllerandassertHttpControllermethods.TypeScript Interface Enhancement:
IMcpLlmController: Added a warning in theIMcpLlmControllerinterface documentation to inform users about the need to install the@modelcontextprotocol/sdkpackage for proper type validation. This ensures better developer awareness and reduces potential issues with theclienttype defaulting toany.