Skip to content

armgit / camel

Public Imported from GitHub
0

🐫 CAMEL: The first and the best multi-agent framework. Finding the Scaling Law of Agents. https://www.camel-ai.org

feat: camel toolkits as mcp server (#1999)

koch3092ebebdbd5694a
diff --git a/camel/toolkits/__init__.py b/camel/toolkits/__init__.py
index e802e6825..c548373eb 100644
--- a/camel/toolkits/__init__.py
+++ b/camel/toolkits/__init__.py
@@ -37,6 +37,7 @@ from .github_toolkit import GithubToolkit
from .google_scholar_toolkit import GoogleScholarToolkit
from .arxiv_toolkit import ArxivToolkit
from .slack_toolkit import SlackToolkit
+from .whatsapp_toolkit import WhatsAppToolkit
from .twitter_toolkit import TwitterToolkit
from .open_api_toolkit import OpenAPIToolkit
from .retrieval_toolkit import RetrievalToolkit
@@ -60,6 +61,7 @@ from .browser_toolkit import BrowserToolkit
from .file_write_toolkit import FileWriteToolkit
from .terminal_toolkit import TerminalToolkit
from .pubmed_toolkit import PubMedToolkit
+from .data_commons_toolkit import DataCommonsToolkit
from .thinking_toolkit import ThinkingToolkit
from .openai_agent_toolkit import OpenAIAgentToolkit
from .searxng_toolkit import SearxNGToolkit
@@ -77,6 +79,7 @@ __all__ = [
'GoogleMapsToolkit',
'SearchToolkit',
'SlackToolkit',
+ 'WhatsAppToolkit',
'DalleToolkit',
'TwitterToolkit',
'WeatherToolkit',
@@ -103,7 +106,6 @@ __all__ = [
'MinerUToolkit',
'MemoryToolkit',
'MCPToolkit',
- 'MCPToolkitManager',
'AudioAnalysisToolkit',
'ExcelToolkit',
'VideoAnalysisToolkit',
@@ -112,6 +114,7 @@ __all__ = [
'FileWriteToolkit',
'TerminalToolkit',
'PubMedToolkit',
+ 'DataCommonsToolkit',
'ThinkingToolkit',
'OpenAIAgentToolkit',
'SearxNGToolkit',
diff --git a/camel/toolkits/arxiv_toolkit.py b/camel/toolkits/arxiv_toolkit.py
index ff9003f41..5e80b48b3 100644
--- a/camel/toolkits/arxiv_toolkit.py
+++ b/camel/toolkits/arxiv_toolkit.py
@@ -17,11 +17,12 @@ from typing import Dict, Generator, List, Optional
from camel.logger import get_logger
from camel.toolkits.base import BaseToolkit
from camel.toolkits.function_tool import FunctionTool
-from camel.utils import dependencies_required
+from camel.utils import MCPServer, dependencies_required
logger = get_logger(__name__)
+@MCPServer()
class ArxivToolkit(BaseToolkit):
r"""A toolkit for interacting with the arXiv API to search and download
academic papers.
diff --git a/camel/toolkits/ask_news_toolkit.py b/camel/toolkits/ask_news_toolkit.py
index 2bd1edcff..ed5ed2a7d 100644
--- a/camel/toolkits/ask_news_toolkit.py
+++ b/camel/toolkits/ask_news_toolkit.py
@@ -17,6 +17,7 @@ from typing import List, Literal, Optional, Tuple, Union
from camel.toolkits import FunctionTool
from camel.toolkits.base import BaseToolkit
+from camel.utils import MCPServer, api_keys_required
def _process_response(
@@ -55,6 +56,10 @@ def _process_response(
raise ValueError(f"Invalid return_type: {return_type}")
+@api_keys_required(
+ [(None, "ASKNEWS_CLIENT_ID"), (None, "ASKNEWS_CLIENT_SECRET")]
+)
+@MCPServer()
class AskNewsToolkit(BaseToolkit):
r"""A class representing a toolkit for interacting with the AskNews API.
@@ -62,7 +67,10 @@ class AskNewsToolkit(BaseToolkit):
based on user queries using the AskNews API.
"""
- def __init__(self, timeout: Optional[float] = None):
+ def __init__(
+ self,
+ timeout: Optional[float] = None,
+ ):
r"""Initialize the AskNewsToolkit with API clients.The API keys and
credentials are retrieved from environment variables.
"""
diff --git a/camel/toolkits/audio_analysis_toolkit.py b/camel/toolkits/audio_analysis_toolkit.py
index aa51aae38..1ed617725 100644
--- a/camel/toolkits/audio_analysis_toolkit.py
+++ b/camel/toolkits/audio_analysis_toolkit.py
@@ -23,6 +23,7 @@ from camel.messages import BaseMessage
from camel.models import BaseAudioModel, BaseModelBackend, OpenAIAudioModels
from camel.toolkits.base import BaseToolkit
from camel.toolkits.function_tool import FunctionTool
+from camel.utils import MCPServer
logger = get_logger(__name__)
@@ -80,6 +81,7 @@ def download_file(url: str, cache_dir: str) -> str:
return local_path
+@MCPServer()
class AudioAnalysisToolkit(BaseToolkit):
r"""A toolkit for audio processing and analysis.
diff --git a/camel/toolkits/base.py b/camel/toolkits/base.py
index c0cf168a0..6ea8248be 100644
--- a/camel/toolkits/base.py
+++ b/camel/toolkits/base.py
@@ -25,6 +25,9 @@ class BaseToolkit(metaclass=AgentOpsMeta):
timeout (Optional[float]): The timeout for the toolkit.
"""
+ from mcp.server import FastMCP
+
+ mcp: FastMCP
timeout: Optional[float] = None
def __init__(self, timeout: Optional[float] = None):
diff --git a/camel/toolkits/code_execution.py b/camel/toolkits/code_execution.py
index a6a73dd83..fe6e53a91 100644
--- a/camel/toolkits/code_execution.py
+++ b/camel/toolkits/code_execution.py
@@ -22,8 +22,10 @@ from camel.interpreters import (
)
from camel.toolkits import FunctionTool
from camel.toolkits.base import BaseToolkit
+from camel.utils import MCPServer
+@MCPServer()
class CodeExecutionToolkit(BaseToolkit):
r"""A tookit for code execution.
diff --git a/camel/toolkits/dappier_toolkit.py b/camel/toolkits/dappier_toolkit.py
index 0dbf5128f..34fd6ec39 100644
--- a/camel/toolkits/dappier_toolkit.py
+++ b/camel/toolkits/dappier_toolkit.py
@@ -16,9 +16,10 @@ from typing import Dict, List, Literal, Optional, Union
from camel.toolkits.base import BaseToolkit
from camel.toolkits.function_tool import FunctionTool
-from camel.utils import api_keys_required, dependencies_required
+from camel.utils import MCPServer, api_keys_required, dependencies_required
+@MCPServer()
class DappierToolkit(BaseToolkit):
r"""A class representing a toolkit for interacting with the Dappier API.
diff --git a/camel/toolkits/data_commons_toolkit.py b/camel/toolkits/data_commons_toolkit.py
index 153500bdd..483dc560f 100644
--- a/camel/toolkits/data_commons_toolkit.py
+++ b/camel/toolkits/data_commons_toolkit.py
@@ -16,10 +16,12 @@ from typing import Any, Dict, List, Optional, Union
from camel.toolkits import FunctionTool
from camel.toolkits.base import BaseToolkit
+from camel.utils import MCPServer
logger = logging.getLogger(__name__)
+@MCPServer()
class DataCommonsToolkit(BaseToolkit):
r"""A class representing a toolkit for Data Commons.
diff --git a/camel/toolkits/excel_toolkit.py b/camel/toolkits/excel_toolkit.py
index dc6b55fb6..7b80f6edb 100644
--- a/camel/toolkits/excel_toolkit.py
+++ b/camel/toolkits/excel_toolkit.py
@@ -19,10 +19,12 @@ import pandas as pd
from camel.logger import get_logger
from camel.toolkits.base import BaseToolkit
from camel.toolkits.function_tool import FunctionTool
+from camel.utils import MCPServer
logger = get_logger(__name__)
+@MCPServer()
class ExcelToolkit(BaseToolkit):
r"""A class representing a toolkit for extract detailed cell information
from an Excel file.
diff --git a/camel/toolkits/file_write_toolkit.py b/camel/toolkits/file_write_toolkit.py
index 7fa6317f8..e2470460d 100644
--- a/camel/toolkits/file_write_toolkit.py
+++ b/camel/toolkits/file_write_toolkit.py
@@ -21,6 +21,7 @@ from typing import List, Optional, Union
from camel.logger import get_logger
from camel.toolkits.base import BaseToolkit
from camel.toolkits.function_tool import FunctionTool
+from camel.utils import MCPServer
logger = get_logger(__name__)
@@ -28,6 +29,7 @@ logger = get_logger(__name__)
DEFAULT_FORMAT = '.md'
+@MCPServer()
class FileWriteToolkit(BaseToolkit):
r"""A toolkit for creating, writing, and modifying text in files.
diff --git a/camel/toolkits/github_toolkit.py b/camel/toolkits/github_toolkit.py
index ccee8c718..1c401f227 100644
--- a/camel/toolkits/github_toolkit.py
+++ b/camel/toolkits/github_toolkit.py
@@ -18,11 +18,12 @@ from typing import Dict, List, Literal, Optional, Union
from camel.toolkits import FunctionTool
from camel.toolkits.base import BaseToolkit
-from camel.utils import dependencies_required
+from camel.utils import MCPServer, dependencies_required
logger = logging.getLogger(__name__)
+@MCPServer()
class GithubToolkit(BaseToolkit):
r"""A class representing a toolkit for interacting with GitHub
repositories.
diff --git a/camel/toolkits/google_scholar_toolkit.py b/camel/toolkits/google_scholar_toolkit.py
index d8ff11387..738598b1a 100644
--- a/camel/toolkits/google_scholar_toolkit.py
+++ b/camel/toolkits/google_scholar_toolkit.py
@@ -16,8 +16,10 @@ from typing import Any, Dict, List, Optional
from camel.toolkits import FunctionTool
from camel.toolkits.base import BaseToolkit
+from camel.utils import MCPServer
+@MCPServer()
class GoogleScholarToolkit(BaseToolkit):
r"""A toolkit for retrieving information about authors and their
publications from Google Scholar.
diff --git a/camel/toolkits/image_analysis_toolkit.py b/camel/toolkits/image_analysis_toolkit.py
index 07efa7ae5..53f193859 100644
--- a/camel/toolkits/image_analysis_toolkit.py
+++ b/camel/toolkits/image_analysis_toolkit.py
@@ -25,10 +25,12 @@ from camel.models import BaseModelBackend, ModelFactory
from camel.toolkits import FunctionTool
from camel.toolkits.base import BaseToolkit
from camel.types import ModelPlatformType, ModelType
+from camel.utils import MCPServer
logger = get_logger(__name__)
+@MCPServer()
class ImageAnalysisToolkit(BaseToolkit):
r"""A toolkit for comprehensive image analysis and understanding.
The toolkit uses vision-capable language models to perform these tasks.
diff --git a/camel/toolkits/linkedin_toolkit.py b/camel/toolkits/linkedin_toolkit.py
index c1989b64f..9cced87e9 100644
--- a/camel/toolkits/linkedin_toolkit.py
+++ b/camel/toolkits/linkedin_toolkit.py
@@ -21,11 +21,12 @@ import requests
from camel.toolkits import FunctionTool
from camel.toolkits.base import BaseToolkit
-from camel.utils import handle_http_error
+from camel.utils import MCPServer, handle_http_error
LINKEDIN_POST_LIMIT = 1300
+@MCPServer()
class LinkedInToolkit(BaseToolkit):
r"""A class representing a toolkit for LinkedIn operations.
diff --git a/camel/toolkits/math_toolkit.py b/camel/toolkits/math_toolkit.py
index ab222c1a3..24c5b70b1 100644
--- a/camel/toolkits/math_toolkit.py
+++ b/camel/toolkits/math_toolkit.py
@@ -16,8 +16,10 @@ from typing import List
from camel.toolkits.base import BaseToolkit
from camel.toolkits.function_tool import FunctionTool
+from camel.utils import MCPServer
+@MCPServer()
class MathToolkit(BaseToolkit):
r"""A class representing a toolkit for mathematical operations.
diff --git a/camel/toolkits/meshy_toolkit.py b/camel/toolkits/meshy_toolkit.py
index 19f8cc30c..532524124 100644
--- a/camel/toolkits/meshy_toolkit.py
+++ b/camel/toolkits/meshy_toolkit.py
@@ -18,9 +18,10 @@ from typing import Any, Dict, Optional
import requests
from camel.toolkits.base import BaseToolkit
-from camel.utils import api_keys_required
+from camel.utils import MCPServer, api_keys_required
+@MCPServer()
class MeshyToolkit(BaseToolkit):
r"""A class representing a toolkit for 3D model generation using Meshy.
diff --git a/camel/toolkits/networkx_toolkit.py b/camel/toolkits/networkx_toolkit.py
index 55ffb7628..752e4b337 100644
--- a/camel/toolkits/networkx_toolkit.py
+++ b/camel/toolkits/networkx_toolkit.py
@@ -18,10 +18,12 @@ from typing import Any, Callable, Dict, List, Literal, Optional, Tuple, Union
from camel.logger import get_logger
from camel.toolkits import FunctionTool
from camel.toolkits.base import BaseToolkit
+from camel.utils import MCPServer
logger = get_logger(__name__)
+@MCPServer()
class NetworkXToolkit(BaseToolkit):
_nx = None # Class variable to store the networkx module
diff --git a/camel/toolkits/notion_toolkit.py b/camel/toolkits/notion_toolkit.py
index 4b5b6ebde..dfdb877d3 100644
--- a/camel/toolkits/notion_toolkit.py
+++ b/camel/toolkits/notion_toolkit.py
@@ -16,6 +16,7 @@ from typing import List, Optional, cast
from camel.toolkits import FunctionTool
from camel.toolkits.base import BaseToolkit
+from camel.utils import MCPServer, api_keys_required
def get_plain_text_from_rich_text(rich_text: List[dict]) -> str:
@@ -66,6 +67,7 @@ def get_media_source_text(block: dict) -> str:
return source
+@MCPServer()
class NotionToolkit(BaseToolkit):
r"""A toolkit for retrieving information from the user's notion pages.
@@ -76,6 +78,11 @@ class NotionToolkit(BaseToolkit):
the notion APIs.
"""
+ @api_keys_required(
+ [
+ ("notion_token", 'NOTION_TOKEN'),
+ ]
+ )
def __init__(
self,
notion_token: Optional[str] = None,
diff --git a/camel/toolkits/openbb_toolkit.py b/camel/toolkits/openbb_toolkit.py
index 61f7ec9e2..f88d7989f 100644
--- a/camel/toolkits/openbb_toolkit.py
+++ b/camel/toolkits/openbb_toolkit.py
@@ -17,9 +17,10 @@ from typing import List, Literal, Optional
from camel.toolkits.base import BaseToolkit
from camel.toolkits.function_tool import FunctionTool
-from camel.utils import api_keys_required, dependencies_required
+from camel.utils import MCPServer, api_keys_required, dependencies_required
+@MCPServer()
class OpenBBToolkit(BaseToolkit):
r"""A toolkit for accessing financial data and analysis through OpenBB
Platform.
diff --git a/camel/toolkits/pubmed_toolkit.py b/camel/toolkits/pubmed_toolkit.py
index e3bd7d3be..ae285293f 100644
--- a/camel/toolkits/pubmed_toolkit.py
+++ b/camel/toolkits/pubmed_toolkit.py
@@ -18,10 +18,12 @@ import requests
from camel.logger import get_logger
from camel.toolkits import BaseToolkit, FunctionTool
+from camel.utils import MCPServer
logger = get_logger(__name__)
+@MCPServer()
class PubMedToolkit(BaseToolkit):
r"""A toolkit for interacting with PubMed's E-utilities API to access
MEDLINE data.
diff --git a/camel/toolkits/reddit_toolkit.py b/camel/toolkits/reddit_toolkit.py
index 19c67a24e..c8e29b039 100644
--- a/camel/toolkits/reddit_toolkit.py
+++ b/camel/toolkits/reddit_toolkit.py
@@ -18,9 +18,10 @@ from typing import Any, Dict, List, Optional, Union
from camel.toolkits import FunctionTool
from camel.toolkits.base import BaseToolkit
-from camel.utils import retry_on_error
+from camel.utils import MCPServer, retry_on_error
+@MCPServer()
class RedditToolkit(BaseToolkit):
r"""A class representing a toolkit for Reddit operations.
diff --git a/camel/toolkits/retrieval_toolkit.py b/camel/toolkits/retrieval_toolkit.py
index c1dc0486d..0f23ea2d1 100644
--- a/camel/toolkits/retrieval_toolkit.py
+++ b/camel/toolkits/retrieval_toolkit.py
@@ -17,9 +17,10 @@ from camel.retrievers import AutoRetriever
from camel.toolkits import FunctionTool
from camel.toolkits.base import BaseToolkit
from camel.types import StorageType
-from camel.utils import Constants
+from camel.utils import Constants, MCPServer
+@MCPServer()
class RetrievalToolkit(BaseToolkit):
r"""A class representing a toolkit for information retrieval.
diff --git a/camel/toolkits/search_toolkit.py b/camel/toolkits/search_toolkit.py
index 1c7c89ce8..f0431eddf 100644
--- a/camel/toolkits/search_toolkit.py
+++ b/camel/toolkits/search_toolkit.py
@@ -19,9 +19,10 @@ import requests
from camel.toolkits.base import BaseToolkit
from camel.toolkits.function_tool import FunctionTool
-from camel.utils import api_keys_required, dependencies_required
+from camel.utils import MCPServer, api_keys_required, dependencies_required
+@MCPServer()
class SearchToolkit(BaseToolkit):
r"""A class representing a toolkit for web search.
diff --git a/camel/toolkits/semantic_scholar_toolkit.py b/camel/toolkits/semantic_scholar_toolkit.py
index 0aa043302..c46ab866a 100644
--- a/camel/toolkits/semantic_scholar_toolkit.py
+++ b/camel/toolkits/semantic_scholar_toolkit.py
@@ -19,8 +19,10 @@ import requests
from camel.toolkits import FunctionTool
from camel.toolkits.base import BaseToolkit
+from camel.utils import MCPServer
+@MCPServer()
class SemanticScholarToolkit(BaseToolkit):
r"""A toolkit for interacting with the Semantic Scholar
API to fetch paper and author data.
diff --git a/camel/toolkits/slack_toolkit.py b/camel/toolkits/slack_toolkit.py
index 8dcc2be35..bca614715 100644
--- a/camel/toolkits/slack_toolkit.py
+++ b/camel/toolkits/slack_toolkit.py
@@ -20,6 +20,7 @@ import os
from typing import TYPE_CHECKING, List, Optional
from camel.toolkits.base import BaseToolkit
+from camel.utils import MCPServer
if TYPE_CHECKING:
from ssl import SSLContext
@@ -31,6 +32,7 @@ from camel.toolkits import FunctionTool
logger = logging.getLogger(__name__)
+@MCPServer()
class SlackToolkit(BaseToolkit):
r"""A class representing a toolkit for Slack operations.
diff --git a/camel/toolkits/stripe_toolkit.py b/camel/toolkits/stripe_toolkit.py
index 3b66acea7..d32e034a0 100644
--- a/camel/toolkits/stripe_toolkit.py
+++ b/camel/toolkits/stripe_toolkit.py
@@ -19,9 +19,10 @@ from typing import List, Optional
from camel.toolkits import FunctionTool
from camel.toolkits.base import BaseToolkit
-from camel.utils import api_keys_required
+from camel.utils import MCPServer, api_keys_required
+@MCPServer()
class StripeToolkit(BaseToolkit):
r"""A class representing a toolkit for Stripe operations.
diff --git a/camel/toolkits/sympy_toolkit.py b/camel/toolkits/sympy_toolkit.py
index 90800e14c..68fbad50e 100644
--- a/camel/toolkits/sympy_toolkit.py
+++ b/camel/toolkits/sympy_toolkit.py
@@ -18,10 +18,12 @@ from typing import List, Optional
from camel.logger import get_logger
from camel.toolkits import FunctionTool
from camel.toolkits.base import BaseToolkit
+from camel.utils import MCPServer
logger = get_logger(__name__)
+@MCPServer()
class SymPyToolkit(BaseToolkit):
r"""A toolkit for performing symbolic computations using SymPy.
This includes methods for Algebraic manipulation calculus
diff --git a/camel/toolkits/terminal_toolkit.py b/camel/toolkits/terminal_toolkit.py
index 31f331526..e66f28b69 100644
--- a/camel/toolkits/terminal_toolkit.py
+++ b/camel/toolkits/terminal_toolkit.py
@@ -19,10 +19,12 @@ from typing import Any, Dict, List, Optional
from camel.logger import get_logger
from camel.toolkits.base import BaseToolkit
from camel.toolkits.function_tool import FunctionTool
+from camel.utils import MCPServer
logger = get_logger(__name__)
+@MCPServer()
class TerminalToolkit(BaseToolkit):
r"""A toolkit for terminal operations across multiple operating systems.
diff --git a/camel/toolkits/twitter_toolkit.py b/camel/toolkits/twitter_toolkit.py
index d3ae237f7..a16d35326 100644
--- a/camel/toolkits/twitter_toolkit.py
+++ b/camel/toolkits/twitter_toolkit.py
@@ -23,7 +23,7 @@ from requests_oauthlib import OAuth1
from camel.logger import get_logger
from camel.toolkits import FunctionTool
from camel.toolkits.base import BaseToolkit
-from camel.utils import api_keys_required
+from camel.utils import MCPServer, api_keys_required
TWEET_TEXT_LIMIT = 280
@@ -418,6 +418,7 @@ def _handle_http_error(response: requests.Response) -> str:
return "Unexpected Exception"
+@MCPServer()
class TwitterToolkit(BaseToolkit):
r"""A class representing a toolkit for Twitter operations.
diff --git a/camel/toolkits/video_analysis_toolkit.py b/camel/toolkits/video_analysis_toolkit.py
index 6cc593893..e0ab56411 100644
--- a/camel/toolkits/video_analysis_toolkit.py
+++ b/camel/toolkits/video_analysis_toolkit.py
@@ -24,7 +24,7 @@ from camel.messages import BaseMessage
from camel.models import BaseModelBackend, OpenAIAudioModels
from camel.toolkits.base import BaseToolkit
from camel.toolkits.function_tool import FunctionTool
-from camel.utils import dependencies_required
+from camel.utils import MCPServer, dependencies_required
from .video_download_toolkit import (
VideoDownloaderToolkit,
@@ -77,6 +77,7 @@ similar-looking species or objects
"""
+@MCPServer()
class VideoAnalysisToolkit(BaseToolkit):
r"""A class for analysing videos with vision-language model.
diff --git a/camel/toolkits/video_download_toolkit.py b/camel/toolkits/video_download_toolkit.py
index cd0bd68f6..637198873 100644
--- a/camel/toolkits/video_download_toolkit.py
+++ b/camel/toolkits/video_download_toolkit.py
@@ -23,7 +23,7 @@ from PIL import Image
from camel.logger import get_logger
from camel.toolkits.base import BaseToolkit
from camel.toolkits.function_tool import FunctionTool
-from camel.utils import dependencies_required
+from camel.utils import MCPServer, dependencies_required
logger = get_logger(__name__)
@@ -54,6 +54,7 @@ def _capture_screenshot(video_file: str, timestamp: float) -> Image.Image:
return Image.open(io.BytesIO(out))
+@MCPServer()
class VideoDownloaderToolkit(BaseToolkit):
r"""A class for downloading videos and optionally splitting them into
chunks.
diff --git a/camel/toolkits/weather_toolkit.py b/camel/toolkits/weather_toolkit.py
index 29914bc83..66c2ded42 100644
--- a/camel/toolkits/weather_toolkit.py
+++ b/camel/toolkits/weather_toolkit.py
@@ -16,8 +16,10 @@ from typing import List, Literal
from camel.toolkits.base import BaseToolkit
from camel.toolkits.function_tool import FunctionTool
+from camel.utils import MCPServer
+@MCPServer()
class WeatherToolkit(BaseToolkit):
r"""A class representing a toolkit for interacting with weather data.
diff --git a/camel/toolkits/whatsapp_toolkit.py b/camel/toolkits/whatsapp_toolkit.py
index 804377854..884140b79 100644
--- a/camel/toolkits/whatsapp_toolkit.py
+++ b/camel/toolkits/whatsapp_toolkit.py
@@ -19,9 +19,10 @@ import requests
from camel.toolkits import FunctionTool
from camel.toolkits.base import BaseToolkit
-from camel.utils import retry_on_error
+from camel.utils import MCPServer, retry_on_error
+@MCPServer()
class WhatsAppToolkit(BaseToolkit):
r"""A class representing a toolkit for WhatsApp operations.
diff --git a/camel/toolkits/zapier_toolkit.py b/camel/toolkits/zapier_toolkit.py
index 08b623c07..a6e9d51fc 100644
--- a/camel/toolkits/zapier_toolkit.py
+++ b/camel/toolkits/zapier_toolkit.py
@@ -19,9 +19,10 @@ import requests
from camel.toolkits.base import BaseToolkit
from camel.toolkits.function_tool import FunctionTool
-from camel.utils import api_keys_required, dependencies_required
+from camel.utils import MCPServer, api_keys_required, dependencies_required
+@MCPServer()
class ZapierToolkit(BaseToolkit):
r"""A class representing a toolkit for interacting with Zapier's NLA API.
diff --git a/camel/utils/__init__.py b/camel/utils/__init__.py
index ffdc26a0a..64eff9fcd 100644
--- a/camel/utils/__init__.py
+++ b/camel/utils/__init__.py
@@ -41,6 +41,7 @@ from .commons import (
)
from .constants import Constants
from .deduplication import DeduplicationResult, deduplicate_internally
+from .mcp import MCPServer
from .response_format import get_pydantic_model
from .token_counting import (
AnthropicTokenCounter,
@@ -88,4 +89,5 @@ __all__ = [
"retry_on_error",
"BatchProcessor",
"with_timeout",
+ "MCPServer",
]
diff --git a/camel/utils/mcp.py b/camel/utils/mcp.py
new file mode 100644
index 000000000..bcb4a415d
--- /dev/null
+++ b/camel/utils/mcp.py
@@ -0,0 +1,79 @@
+# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
+import functools
+import inspect
+from typing import Any, Callable, Optional
+
+
+class MCPServer:
+ def __init__(
+ self,
+ function_names: Optional[list[str]] = None,
+ server_name: Optional[str] = None,
+ ):
+ self.function_names = function_names
+ self.server_name = server_name
+
+ def make_wrapper(self, func: Callable[..., Any]) -> Callable[..., Any]:
+ if inspect.iscoroutinefunction(func):
+
+ @functools.wraps(func)
+ async def wrapper(*args, **kwargs):
+ return await func(*args, **kwargs)
+ else:
+
+ @functools.wraps(func)
+ def wrapper(*args, **kwargs):
+ return func(*args, **kwargs)
+
+ wrapper.__signature__ = inspect.signature(func) # type: ignore[attr-defined]
+ return wrapper
+
+ def __call__(self, cls):
+ from mcp.server.fastmcp import FastMCP
+
+ from camel.toolkits.base import BaseToolkit
+
+ original_init = cls.__init__
+
+ def new_init(instance, *args, **kwargs):
+ original_init(instance, *args, **kwargs)
+ self.server_name = self.server_name or cls.__name__
+ instance.mcp = FastMCP(self.server_name)
+
+ if not self.function_names and not isinstance(
+ instance, BaseToolkit
+ ):
+ raise ValueError(
+ "Please specify function names or use BaseToolkit."
+ )
+
+ function_names = self.function_names
+ if not function_names and isinstance(instance, BaseToolkit):
+ function_names = [
+ tool.get_function_name() for tool in instance.get_tools()
+ ]
+
+ for name in function_names:
+ func = getattr(instance, name, None)
+ if func is None or not callable(func):
+ raise ValueError(
+ f"Method {name} not found in class {cls.__name} or "
+ "cannot be called."
+ )
+ wrapper = self.make_wrapper(func)
+ instance.mcp.tool(name=name)(wrapper)
+
+ cls.__init__ = new_init
+ return cls
diff --git a/docs/key_modules/tools.md b/docs/key_modules/tools.md
index 59d4153e4..d65c43a3b 100644
--- a/docs/key_modules/tools.md
+++ b/docs/key_modules/tools.md
@@ -191,6 +191,131 @@ CAMEL provides a variety of built-in toolkits that you can use right away. Here'
| WhatsAppToolkit | A toolkit for interacting with the WhatsApp Business API, including sending messages, managing message templates, and accessing business profile information. |
| ZapierToolkit | A toolkit for interacting with Zapier's NLA API to execute actions through natural language commands and automate workflows. |
-## 4. Conclusion
+## 4. Using Toolkits as MCP Servers
+
+CAMEL supports the Model Context Protocol (MCP), which allows you to expose toolkits as standalone servers that can be accessed by clients. This enables distributed tool execution and integration with various systems.
+
+### 4.1 What is MCP?
+
+Model Context Protocol (MCP) is a protocol that enables language models to interact with external tools and services. In CAMEL, toolkits can be exposed as MCP servers, allowing clients to discover and call tools remotely.
+
+### 4.2 Creating an MCP Server from a Toolkit
+
+Any CAMEL toolkit can be exposed as an MCP server. Here's how to create an MCP server using the ArXiv toolkit as an example:
+
+```python
+# arxiv_toolkit_server.py
+import argparse
+import sys
+
+from camel.toolkits import ArxivToolkit
+
+if __name__ == "__main__":
+ parser = argparse.ArgumentParser(
+ description="Run Arxiv Toolkit with MCP server mode.",
+ usage=f"python {sys.argv[0]} [--mode MODE]",
+ )
+ parser.add_argument(
+ "--mode",
+ choices=["stdio", "sse"],
+ default="stdio",
+ help="MCP server mode (default: 'stdio')",
+ )
+ parser.add_argument(
+ "--timeout",
+ type=float,
+ default=None,
+ help="Timeout for the MCP server (default: None)",
+ )
+
+ args = parser.parse_args()
+
+ toolkit = ArxivToolkit(timeout=args.timeout)
+
+ # Run the toolkit as an MCP server
+ toolkit.mcp.run(args.mode)
+```
+
+The server can be run in two modes:
+- `stdio`: Standard input/output mode (default)
+- `sse`: Server-Sent Events mode
+
+### 4.3 Configuring MCP Servers
+
+Create a configuration file (e.g., `mcp_servers_config.json`) to specify how to launch your MCP servers:
+
+```json
+{
+ "mcpServers": {
+ "arxiv_toolkit": {
+ "command": "python",
+ "args": [
+ "-m",
+ "examples.mcp_arxiv_toolkit.arxiv_toolkit_server",
+ "--timeout",
+ "30"
+ ]
+ }
+ }
+}
+```
+
+### 4.4 Connecting to MCP Servers from a Client
+
+You can connect to MCP servers and use their tools from a client application:
+
+```python
+import asyncio
+from mcp.types import CallToolResult
+from camel.toolkits.mcp_toolkit import MCPToolkit, _MCPServer
+
+async def run_example():
+ # Initialize the MCPToolkit with your configuration file
+ mcp_toolkit = MCPToolkit(config_path="path/to/mcp_servers_config.json")
+
+ # Connect to all configured MCP servers
+ await mcp_toolkit.connect()
+
+ # Get the first MCP server
+ mcp_client: _MCPServer = mcp_toolkit.servers[0]
+
+ # List available tools from the server
+ res = await mcp_client.list_mcp_tools()
+ if isinstance(res, str):
+ raise Exception(res)
+
+ tools = [tool.name for tool in res.tools]
+ print(f"Available tools: {tools}")
+
+ # Call a tool from the server
+ result: CallToolResult = await mcp_client.session.call_tool(
+ "tool_name", {"param1": "value1", "param2": "value2"}
+ )
+ print(result.content[0].text)
+
+ # Disconnect from all servers
+ await mcp_toolkit.disconnect()
+
+if __name__ == "__main__":
+ asyncio.run(run_example())
+```
+
+### 4.5 Benefits of Using MCP Servers
+
+1. **Distributed Execution**: Run tools on separate machines or processes.
+2. **Isolation**: Each toolkit runs in its own process, providing better isolation and stability.
+3. **Resource Management**: Allocate resources to specific toolkits based on their requirements.
+4. **Scalability**: Scale individual toolkits independently based on demand.
+5. **Language Interoperability**: MCP servers can be implemented in different programming languages.
+
+### 4.6 Best Practices
+
+- **Timeouts**: Always set appropriate timeouts to prevent hanging operations.
+- **Error Handling**: Implement proper error handling for both server and client sides.
+- **Resource Cleanup**: Ensure proper disconnection from servers when done.
+- **Configuration Management**: Use environment variables or configuration files for server settings.
+- **Monitoring**: Implement logging and monitoring for MCP servers in production environments.
+
+## 5. Conclusion
Tools are essential for extending the capabilities of CAMEL agents, empowering them to perform a wide range of tasks and collaborate efficiently.
diff --git a/examples/mcp_arxiv_toolkit/arxiv_toolkit_server.py b/examples/mcp_arxiv_toolkit/arxiv_toolkit_server.py
new file mode 100644
index 000000000..bc4828ec4
--- /dev/null
+++ b/examples/mcp_arxiv_toolkit/arxiv_toolkit_server.py
@@ -0,0 +1,41 @@
+# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
+import argparse
+import sys
+
+from camel.toolkits import ArxivToolkit
+
+if __name__ == "__main__":
+ parser = argparse.ArgumentParser(
+ description="Run Arxiv Toolkit with MCP server mode.",
+ usage=f"python {sys.argv[0]} [--mode MODE]",
+ )
+ parser.add_argument(
+ "--mode",
+ choices=["stdio", "sse"],
+ default="stdio",
+ help="MCP server mode (default: 'stdio')",
+ )
+ parser.add_argument(
+ "--timeout",
+ type=float,
+ default=None,
+ help="Timeout for the MCP server (default: None)",
+ )
+
+ args = parser.parse_args()
+
+ toolkit = ArxivToolkit(timeout=args.timeout)
+
+ toolkit.mcp.run(args.mode)
diff --git a/examples/mcp_arxiv_toolkit/client.py b/examples/mcp_arxiv_toolkit/client.py
new file mode 100644
index 000000000..d93665649
--- /dev/null
+++ b/examples/mcp_arxiv_toolkit/client.py
@@ -0,0 +1,69 @@
+# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
+import asyncio
+
+from mcp.types import CallToolResult
+
+from camel.toolkits.mcp_toolkit import MCPToolkit, _MCPServer
+
+
+async def run_example():
+ mcp_toolkit = MCPToolkit(
+ config_path="examples/mcp_arxiv_toolkit/mcp_servers_config.json"
+ )
+
+ await mcp_toolkit.connect()
+
+ # call the server to list the available tools
+ mcp_client: _MCPServer = mcp_toolkit.servers[0]
+ res = await mcp_client.list_mcp_tools()
+ if isinstance(res, str):
+ raise Exception(res)
+
+ tools = [tool.name for tool in res.tools]
+ print(tools)
+ """
+===============================================================================
+['search_papers', 'download_papers']
+===============================================================================
+ """
+
+ res1: CallToolResult = await mcp_client.session.call_tool(
+ "search_papers", {"query": "attention is all you need"}
+ )
+ print(res1.content[0].text[:1000])
+ """
+===============================================================================
+{"title": "Attention Is All You Need But You Don't Need All Of It For
+Inference of Large Language Models", "published_date": "2024-07-22",
+"authors": ["Georgy Tyukin", "Gbetondji J-S Dovonon", "Jean Kaddour",
+"Pasquale Minervini"], "entry_id": "http://arxiv.org/abs/2407.15516v1",
+"summary": "The inference demand for LLMs has skyrocketed in recent months,
+and serving\nmodels with low latencies remains challenging due to the
+quadratic input length\ncomplexity of the attention layers. In this work, we
+investigate the effect of\ndropping MLP and attention layers at inference time
+on the performance of\nLlama-v2 models. We find that dropping dreeper
+attention layers only marginally\ndecreases performance but leads to the best
+speedups alongside dropping entire\nlayers. For example, removing 33\\% of
+attention layers in a 13B Llama2 model\nresults in a 1.8\\% drop in average
+performance over the OpenLLM benchmark. We\nalso observe that skipping layers
+except the latter layers reduces perform
+===============================================================================
+ """
+
+ await mcp_toolkit.disconnect()
+
+
+if __name__ == "__main__":
+ asyncio.run(run_example())
diff --git a/examples/mcp_arxiv_toolkit/mcp_servers_config.json b/examples/mcp_arxiv_toolkit/mcp_servers_config.json
new file mode 100644
index 000000000..94bbc8a9c
--- /dev/null
+++ b/examples/mcp_arxiv_toolkit/mcp_servers_config.json
@@ -0,0 +1,13 @@
+{
+ "mcpServers": {
+ "arxiv_toolkit": {
+ "command": "python",
+ "args": [
+ "-m",
+ "examples.mcp_arxiv_toolkit.arxiv_toolkit_server",
+ "--timeout",
+ "30"
+ ]
+ }
+ }
+}
\ No newline at end of file
diff --git a/test/utils/test_mcp_server.py b/test/utils/test_mcp_server.py
new file mode 100644
index 000000000..445ad0e07
--- /dev/null
+++ b/test/utils/test_mcp_server.py
@@ -0,0 +1,116 @@
+# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
+import asyncio
+import sys
+from typing import TYPE_CHECKING
+
+import pytest
+from mcp.server import FastMCP
+
+from camel.toolkits.mcp_toolkit import _MCPServer
+from camel.utils import MCPServer
+
+if TYPE_CHECKING:
+ from mcp import ClientSession
+
+
+@MCPServer(
+ server_name="TextProcessorForMCP",
+ function_names=["reverse_text", "async_word_count"],
+)
+class TextProcessorForMCP:
+ mcp: FastMCP
+
+ def __init__(self):
+ pass
+
+ def reverse_text(self, text: str) -> str:
+ r"""reverse the text. the function is a synchronous function.
+
+ Args:
+ text (str): the text to reverse
+ """
+ return text[::-1]
+
+ async def async_word_count(self, text: str) -> int:
+ r"""count the number of words in the text. the function is an
+ asynchronous function.
+
+ Args:
+ text (str): the text to count the number of words
+ """
+ await asyncio.sleep(0.01)
+ return len(text.split())
+
+
+def test_tool_schema():
+ processor = TextProcessorForMCP()
+ tools = processor.mcp._tool_manager.list_tools()
+ tool_functions = {tool.name: tool for tool in tools}
+
+ assert "reverse_text" in tool_functions
+ tool1 = tool_functions["reverse_text"]
+ assert tool1.name == "reverse_text"
+ assert tool1.description.startswith(
+ "reverse the text. the function is a synchronous function."
+ )
+ assert "text" in tool1.parameters.get("properties", {})
+ assert "text" in tool1.parameters.get("required", [])
+ assert not tool1.is_async
+
+ assert "async_word_count" in tool_functions
+ tool2 = tool_functions["async_word_count"]
+ assert tool2.name == "async_word_count"
+ assert tool2.description.startswith(
+ "count the number of words in the text. the function is an"
+ )
+ assert "text" in tool2.parameters.get("properties", {})
+ assert "text" in tool2.parameters.get("required", [])
+ assert tool2.is_async
+
+
+async def test_async_word_count():
+ processor = TextProcessorForMCP()
+ server = _MCPServer(
+ command_or_url=sys.executable,
+ args=[__file__, "--server"],
+ )
+ await server.connect()
+ session: "ClientSession" = server._session
+
+ text = "hello world"
+
+ result = await session.call_tool(
+ name="reverse_text",
+ arguments={"text": text},
+ )
+ assert len(result.content) == 1
+ assert result.content[0].text == processor.reverse_text(text)
+
+ result = await session.call_tool(
+ name="async_word_count",
+ arguments={"text": text},
+ )
+ assert len(result.content) == 1
+ assert int(result.content[0].text) == await processor.async_word_count(
+ text
+ )
+ await server.disconnect()
+
+
+if __name__ == "__main__":
+ if "--server" in sys.argv:
+ processor = TextProcessorForMCP()
+ processor.mcp.run("stdio")