feat: add Klavis MCP Server Tools doc

[zihaolin96]

Summary

Added comprehensive documentation for the new KlavisMcpServerTools integration, enabling CrewAI agents to interact with Tools from Klavis MCP servers for enterprise automation workflows.

What's Added

• Complete setup guide with installation steps and API key configuration
• Detailed usage example showing Salesforce MCP Server integration
• Configuration options including tool filtering capabilities
• Others
• follow up on this PR

Demo

https://youtu.be/hZ5oqBMk-fQ

[joaomdmoura]

Disclaimer: This review was made by a crew of AI Agents.

Code Review Comment for PR #3080 - Add Klavis Tools Documentation

Overview

Thank you for your work on adding comprehensive documentation for the Klavis MCP Server Tools in both English and Portuguese. This effort is crucial for enhancing user understanding and adoption of the tools. I have reviewed the changes across the four modified files and here are my insights:

Files Reviewed and Suggestions

1. docs/docs.json

Review Findings:

• The addition of klavistool.mdx is well done and the JSON structure is maintained.
• No issues identified.

Suggestions:

• Consider providing a versioning or categorization system within this file for better navigation as the project grows.

2. docs/en/tools/automation/klavistool.mdx

Review Findings:

• The documentation is structured effectively, with clear sections and comprehensive code examples.
• Proper MDX formatting ensures it renders well in the documentation site.

Suggestions for Improvement:

1. Add Version Compatibility Information:

   ## Compatibility
   - Minimum CrewAI version: X.X.X
   - Minimum Klavis version: X.X.X

2. Error Handling Section:
   Including error-handling examples will guide users through common issues:

   try:
       mcp_server = klavis_client.mcp_server.create_server_instance(
           server_name=McpServerName.SALESFORCE,
           user_id="123",
           platform_name="Klavis"
       )
   except KlavisError as e:
       print(f"Failed to create MCP server instance: {e}")

3. Type Hints in Code Examples:
   Adding type hints is a best practice for clarity:

   from typing import List, Optional
   
   def create_klavis_tools(
       api_key: str,
       server_url: str,
       tool_list: Optional[List[str]] = None
   ) -> KlavisMcpServerTools:
       return KlavisMcpServerTools(
           klavis_api_key=api_key,
           mcp_server_url=server_url,
           tool_list=tool_list
       )

3. docs/pt-BR/tools/automation/klavistool.mdx

Review Findings:

• Great job on accurately translating the technical terms while keeping the format consistent with the English version.

Suggestions:

1. Add Language-Specific Error Messages:
   Including localized error messages enhances usability:

   try:
       result = my_agent.execute_task(
           "Obtenha todas as oportunidades abertas para Q4 2024"
       )
   except Exception as e:
       print(f"Erro ao executar tarefa: {e}")

4. docs/en/tools/automation/overview.mdx

Review Findings:

• Clear integration of the Klavis tool within the automation overview.
• Consistent formatting is maintained.

Suggestions for Improved Import Example:

from crewai_tools import (
    ApifyActorTool,
    ComposioTool,
    KlavisMcpServerTools,
    MultiOnTool
)

# Group tools by category for organizational clarity
automation_tools = {
    'web_automation': ApifyActorTool(),
    'platform_integration': ComposioTool(),
    'enterprise_integration': KlavisMcpServerTools(),
    'browser_automation': MultiOnTool()
}

agent = Agent(
    role="Automation Specialist",
    tools=list(automation_tools.values()),
    goal="Automate workflows and integrate systems"
)

General Recommendations

1. Documentation Standards:

   • Introduce a "Troubleshooting" section that provides guidance for common issues.
   • Include information on rate limiting and best practices for API usage.

2. Code Examples:

   • Add examples showcasing more complex integration scenarios.
   • Consider adding async/await examples for improved performance.

3. Security Considerations:

   • Consider including sections on API key security best practices and access token management.

Conclusion

The documentation additions significantly enhance the understanding of the Klavis MCP Server Tools integration. The PR is commendable, and with the implementation of the suggested improvements, it could serve as an even better resource for users. I recommend merging the PR after addressing these constructive suggestions. Thank you for your efforts!

[zihaolin96]

Hey @lucasgomide @greysonlalonde,
I followed the format from the adjacent docs, let me know if you have any questions about this PR. Thanks!

[zihaolin96]

gentle ping, Thanks! @lucasgomide @greysonlalonde,

[zihaolin96]

gentle ping, Thanks! @lucasgomide

[zihaolin96]

gentle ping, Thanks! @lucasgomide @greysonlalonde,

[lucasgomide]

I'm reviewing the tool PR first

[github-actions]

This PR is stale because it has been open for 45 days with no activity.