Add TypeScript documentation and examples for AI agent tools #405
Conversation
MervinPraison
commented
Mar 4, 2025
MervinPraison
commented
- Expanded documentation for TypeScript AI agents with tool registration examples
- Added new documentation pages for custom tools in TypeScript
- Updated installation and quickstart guides to include TypeScript sections
- Created example scripts demonstrating single and multi-agent tool usage
- Introduced new documentation for external tools like Google Trends
- Expanded documentation for TypeScript AI agents with tool registration examples - Added new documentation pages for custom tools in TypeScript - Updated installation and quickstart guides to include TypeScript sections - Created example scripts demonstrating single and multi-agent tool usage - Introduced new documentation for external tools like Google Trends
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hello @MervinPraison, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
Summary of Changes
This pull request by MervinPraison focuses on enhancing the documentation and examples for using PraisonAI agents with TypeScript. It introduces new documentation pages for custom tools, updates installation and quickstart guides to include TypeScript sections, and provides example scripts demonstrating single and multi-agent tool usage. The PR also adds documentation for external tools like Google Trends.
Highlights
- Documentation Expansion: Expanded documentation for TypeScript AI agents, including examples for tool registration and custom tools.
- Installation and Quickstart Updates: Updated installation and quickstart guides to include TypeScript-specific instructions and examples.
- Example Scripts: Added example scripts demonstrating the usage of single and multi-agent tools in TypeScript.
- External Tool Documentation: Introduced documentation for using external tools like Google Trends with PraisonAI agents.
Changelog
Click here to see the changelog
- docs/index.mdx
- Updated the 'No Code' tab to use
praisonaiagentsfor installation. - Added a 'TypeScript' tab with installation instructions, API key setup, and code examples for single and multi-agent scenarios.
- Updated the 'No Code' tab to use
- docs/installation.mdx
- Added a 'TypeScript' tab with instructions for installing PraisonAI using npm and setting the OpenAI API key.
- docs/introduction.mdx
- Added a 'TypeScript' tab with installation instructions, API key setup, and code examples for single and multi-agent scenarios.
- docs/js/customtools.mdx
- Created a new documentation page for creating custom tools in TypeScript, including examples for single and multi-agent setups with weather and time functions.
- docs/js/typescript.mdx
- Removed the 'Single Agent Tool Call' accordion and simplified the 'Direct Function Tools' accordion with streamlined examples.
- docs/mint.json
- Rearranged the documentation structure to group TypeScript agent documentation under a 'TypeScript Agents' section.
- docs/quickstart.mdx
- Added a 'TypeScript' tab with installation instructions, API key setup, and code examples for single and multi-agent scenarios.
- docs/tools/external/google-trends.mdx
- Created a new documentation page for using Google Trends as an external tool with PraisonAI agents, including a Python code example.
- src/praisonai-ts/examples/simple/direct-function-tools.ts
- Simplified the example code by removing unnecessary comments and direct function registration explanations.
- src/praisonai-ts/examples/simple/multi-agent-tools.ts
- Created a new example script demonstrating multi-agent tool usage with weather and time functions.
- src/praisonai-ts/examples/simple/task-based-agent-tools.ts
- Created a new example script demonstrating task-based agent tool usage with weather and time functions.
- src/praisonai-ts/package.json
- Updated the version of the
praisonaidependency from 1.0.18 to 1.0.19.
- Updated the version of the
- src/praisonai-ts/src/tools/test.ts
- Added an empty file
test.tsin thesrc/toolsdirectory.
- Added an empty file
- src/praisonai-ts/tests/development/simple/direct-function-tools.ts
- Simplified the example code by removing unnecessary comments and direct function registration explanations.
- src/praisonai-ts/tests/development/simple/multi-agent-tools.ts
- Created a new example script demonstrating multi-agent tool usage with weather and time functions.
- src/praisonai-ts/tests/development/simple/task-based-agent-tools.ts
- Created a new example script demonstrating task-based agent tool usage with weather and time functions.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Did you know?
TypeScript was created by Anders Hejlsberg at Microsoft, the same person who led the development of C#.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request adds TypeScript documentation and examples for AI agent tools, enhancing the project's accessibility and usability for TypeScript developers. The changes include expanded documentation, new documentation pages for custom tools, updated installation and quickstart guides, and example scripts. Overall, the changes are well-structured and contribute positively to the project.
Merge Readiness
The pull request is well-structured and adds significant value by providing comprehensive TypeScript documentation and examples. The new documentation and updated guides make the project more accessible to TypeScript developers. Given the absence of any identified issues, the pull request appears ready for merging. However, I am unable to directly approve the pull request, and I recommend that other reviewers also examine the changes before merging.
✅ Deploy Preview for praisonai ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
