\"enabled_tools\": [\"tool_name\", ...] '\r\n \"to your config JSON to limit tools.\"\r\n )\r\n else:\r\n lines.append(\r\n \"\"enabled_tools\": [\"tool_name\", ...] '\r\n \"to your config JSON to limit tools.\"\r\n )\r\n return \"\".join(lines)\r\n\r\n\r\n# ---------------------------------------------------------------------------\r\n# MCPTool class\r\n# ---------------------------------------------------------------------------\r\n\r\n\r\nclass MCPTool(BaseTool):\r\n \"\"\"A kotaemon BaseTool wrapper around a single MCP server tool.\r\n\r\n This tool holds the MCP server configuration and establishes\r\n a connection to invoke the tool on demand.\r\n\r\n Example usage::\r\n\r\n tool = MCPTool(\r\n name=\"search\",\r\n description=\"Search the web\",\r\n server_transport=\"stdio\",\r\n server_command=\"uvx\",\r\n server_args=[\"mcp-server-fetch\"],\r\n mcp_tool_name=\"fetch\",\r\n )\r\n result = tool.run(\"https://example.com\")\r\n \"\"\"\r\n\r\n name: str = \"\"\r\n description: str = \"\"\r\n args_schema: Optional[Type[BaseModel]] = None\r\n\r\n # MCP server connection details\r\n server_transport: str = \"stdio\"\r\n server_command: str = \"\"\r\n server_args: list[str] = []\r\n server_env: dict[str, str] = {}\r\n\r\n # The original MCP tool name (on the server)\r\n mcp_tool_name: str = \"\"\r\n\r\n def _run_tool(self, *args: Any, **kwargs: Any) -> str:\r\n \"\"\"Invoke the MCP tool by establishing a session.\"\"\"\r\n return _run_async(self._arun_tool(*args, **kwargs))\r\n\r\n async def _arun_tool(self, *args: Any, **kwargs: Any) -> str:\r\n \"\"\"Async implementation that connects to the MCP server and calls\r\n the tool.\"\"\"\r\n from mcp import ClientSession\r\n from mcp.client.sse import sse_client\r\n from mcp.client.stdio import StdioServerParameters, stdio_client\r\n\r\n # Build tool arguments\r\n if args and isinstance(args[0], str):\r\n try:\r\n tool_args = json.loads(args[0])\r\n except json.JSONDecodeError:\r\n # If not JSON, assume single string argument\r\n if self.args_schema:\r\n first_field = next(iter(self.args_schema.model_fields.keys()))\r\n tool_args = {first_field: args[0]}\r\n else:\r\n tool_args = {\"input\": args[0]}\r\n else:\r\n tool_args = kwargs\r\n\r\n if self.server_transport == \"stdio\":\r\n cmd = self.server_command\r\n cmd_args = self.server_args\r\n # Auto-split if full command string with no separate args\r\n if not cmd_args and \" \" in cmd:\r\n parts = shlex.split(cmd)\r\n cmd = parts[0]\r\n cmd_args = parts[1:]\r\n\r\n server_params = StdioServerParameters(\r\n command=cmd,\r\n args=cmd_args,\r\n env=self.server_env if self.server_env else None,\r\n )\r\n async with stdio_client(server_params) as (read, write):\r\n async with ClientSession(read, write) as session:\r\n await session.initialize()\r\n result = await session.call_tool(self.mcp_tool_name, tool_args)\r\n return self._format_result(result)\r\n elif self.server_transport == \"sse\":\r\n async with sse_client(url=self.server_command) as (read, write):\r\n async with ClientSession(read, write) as session:\r\n await session.initialize()\r\n result = await session.call_tool(self.mcp_tool_name, tool_args)\r\n return self._format_result(result)\r\n else:\r\n return f\"Unsupported transport: {self.server_transport}\"\r\n\r\n def _format_result(self, result: Any) -> str:\r\n \"\"\"Format MCP CallToolResult into a string.\"\"\"\r\n if result.isError:\r\n return f\"MCP Tool Error: {result.content}\"\r\n\r\n parts = []\r\n for content in result.content:\r\n if hasattr(content, \"text\"):\r\n parts.append(content.text)\r\n elif hasattr(content, \"data\"):\r\n parts.append(f\"[Binary data: {content.mimeType}]\")\r\n else:\r\n parts.append(str(content))\r\n return \"\\n\".join(parts)\r\n"
},
{
"path": "libs/kotaemon/kotaemon/agents/tools/wikipedia.py",
"content": "from typing import Any, AnyStr, Optional, Type, Union\n\nfrom pydantic import BaseModel, Field\n\nfrom kotaemon.base import Document\n\nfrom .base import BaseTool\n\n\nclass Wiki:\n \"\"\"Wrapper around wikipedia API.\"\"\"\n\n def __init__(self) -> None:\n \"\"\"Check that wikipedia package is installed.\"\"\"\n try:\n import wikipedia # noqa: F401\n except ImportError:\n raise ValueError(\n \"Could not import wikipedia python package. \"\n \"Please install it with `pip install wikipedia`.\"\n )\n\n def search(self, search: str) -> Union[str, Document]:\n \"\"\"Try to search for wiki page.\n\n If page exists, return the page summary, and a PageWithLookups object.\n If page does not exist, return similar entries.\n \"\"\"\n import wikipedia\n\n try:\n page_content = wikipedia.page(search).content\n url = wikipedia.page(search).url\n result: Union[str, Document] = Document(\n text=page_content, metadata={\"page\": url}\n )\n except wikipedia.PageError:\n result = f\"Could not find [{search}]. Similar: {wikipedia.search(search)}\"\n except wikipedia.DisambiguationError:\n result = f\"Could not find [{search}]. Similar: {wikipedia.search(search)}\"\n return result\n\n\nclass WikipediaArgs(BaseModel):\n query: str = Field(..., description=\"a search query as input to wkipedia\")\n\n\nclass WikipediaTool(BaseTool):\n \"\"\"Tool that adds the capability to query the Wikipedia API.\"\"\"\n\n name: str = \"wikipedia\"\n description: str = (\n \"Search engine from Wikipedia, retrieving relevant wiki page. \"\n \"Useful when you need to get holistic knowledge about people, \"\n \"places, companies, historical events, or other subjects. \"\n \"Input should be a search query.\"\n )\n args_schema: Optional[Type[BaseModel]] = WikipediaArgs\n doc_store: Any = None\n\n def _run_tool(self, query: AnyStr) -> AnyStr:\n if not self.doc_store:\n self.doc_store = Wiki()\n tool = self.doc_store\n evidence = tool.search(query)\n return evidence\n"
},
{
"path": "libs/kotaemon/kotaemon/agents/utils.py",
"content": "from kotaemon.base import Document\n\n\ndef get_plugin_response_content(output) -> str:\n \"\"\"\n Wrapper for AgentOutput content return\n \"\"\"\n if isinstance(output, Document):\n return output.text\n else:\n return str(output)\n\n\ndef calculate_cost(model_name: str, prompt_token: int, completion_token: int) -> float:\n \"\"\"\n Calculate the cost of a prompt and completion.\n\n Returns:\n float: Cost of the provided model name with provided token information\n \"\"\"\n # TODO: to be implemented\n return 0.0\n"
},
{
"path": "libs/kotaemon/kotaemon/base/__init__.py",
"content": "from .component import BaseComponent, Node, Param, lazy\nfrom .schema import (\n AIMessage,\n BaseMessage,\n Document,\n DocumentWithEmbedding,\n ExtractorOutput,\n HumanMessage,\n LLMInterface,\n RetrievedDocument,\n StructuredOutputLLMInterface,\n SystemMessage,\n)\n\n__all__ = [\n \"BaseComponent\",\n \"Document\",\n \"DocumentWithEmbedding\",\n \"BaseMessage\",\n \"SystemMessage\",\n \"AIMessage\",\n \"HumanMessage\",\n \"RetrievedDocument\",\n \"LLMInterface\",\n \"StructuredOutputLLMInterface\",\n \"ExtractorOutput\",\n \"Param\",\n \"Node\",\n \"lazy\",\n]\n"
},
{
"path": "libs/kotaemon/kotaemon/base/component.py",
"content": "from abc import abstractmethod\nfrom typing import Any, AsyncGenerator, Iterator, Optional\n\nfrom theflow import Function, Node, Param, lazy\n\nfrom kotaemon.base.schema import Document\n\n\nclass BaseComponent(Function):\n \"\"\"A component is a class that can be used to compose a pipeline.\n\n !!! tip \"Benefits of component\"\n - Auto caching, logging\n - Allow deployment\n\n !!! tip \"For each component, the spirit is\"\n - Tolerate multiple input types, e.g. str, Document, List[str], List[Document]\n - Enforce single output type. Hence, the output type of a component should be\n as generic as possible.\n \"\"\"\n\n inflow = None\n\n def flow(self):\n if self.inflow is None:\n raise ValueError(\"No inflow provided.\")\n\n if not isinstance(self.inflow, BaseComponent):\n raise ValueError(\n f\"inflow must be a BaseComponent, found {type(self.inflow)}\"\n )\n\n return self.__call__(self.inflow.flow())\n\n def set_output_queue(self, queue):\n self._queue = queue\n for name in self._ff_nodes:\n node = getattr(self, name)\n if isinstance(node, BaseComponent):\n node.set_output_queue(queue)\n\n def report_output(self, output: Optional[Document]):\n if self._queue is not None:\n self._queue.put_nowait(output)\n\n def invoke(self, *args, **kwargs) -> Document | list[Document] | None:\n ...\n\n async def ainvoke(self, *args, **kwargs) -> Document | list[Document] | None:\n ...\n\n def stream(self, *args, **kwargs) -> Iterator[Document] | None:\n ...\n\n def astream(self, *args, **kwargs) -> AsyncGenerator[Document, None] | None:\n ...\n\n @abstractmethod\n def run(\n self, *args, **kwargs\n ) -> Document | list[Document] | Iterator[Document] | None | Any:\n \"\"\"Run the component.\"\"\"\n ...\n\n\n__all__ = [\"BaseComponent\", \"Param\", \"Node\", \"lazy\"]\n"
},
{
"path": "libs/kotaemon/kotaemon/base/schema.py",
"content": "from __future__ import annotations\n\nfrom typing import TYPE_CHECKING, Any, Literal, Optional, TypeVar\n\nfrom langchain.schema.messages import AIMessage as LCAIMessage\nfrom langchain.schema.messages import HumanMessage as LCHumanMessage\nfrom langchain.schema.messages import SystemMessage as LCSystemMessage\nfrom llama_index.core.bridge.pydantic import Field\nfrom llama_index.core.schema import Document as BaseDocument\n\nif TYPE_CHECKING:\n from haystack.schema import Document as HaystackDocument\n from openai.types.chat.chat_completion_message_param import (\n ChatCompletionMessageParam,\n )\n\nIO_Type = TypeVar(\"IO_Type\", \"Document\", str)\nSAMPLE_TEXT = \"A sample Document from kotaemon\"\n\n\nclass Document(BaseDocument):\n \"\"\"\n Base document class, mostly inherited from Document class from llama-index.\n\n This class accept one positional argument `content` of an arbitrary type, which will\n store the raw content of the document. If specified, the class will use\n `content` to initialize the base llama_index class.\n\n Attributes:\n content: raw content of the document, can be anything\n source: id of the source of the Document. Optional.\n channel: the channel to show the document. Optional.:\n - chat: show in chat message\n - info: show in information panel\n - index: show in index panel\n - debug: show in debug panel\n \"\"\"\n\n content: Any = None\n source: Optional[str] = None\n channel: Optional[Literal[\"chat\", \"info\", \"index\", \"debug\", \"plot\"]] = None\n\n def __init__(self, content: Optional[Any] = None, *args, **kwargs):\n if content is None:\n if kwargs.get(\"text\", None) is not None:\n kwargs[\"content\"] = kwargs[\"text\"]\n elif kwargs.get(\"embedding\", None) is not None:\n kwargs[\"content\"] = kwargs[\"embedding\"]\n # default text indicating this document only contains embedding\n kwargs[\"text\"] = \"', # noqa\n )\n text = text.replace(\"
This is a test.
\n\nThis is bold,=\n
asdakl fskljf\nsklf jkslaf;
The end.
\n\n細則 本社編（情報システム部） 分類番号 １５７３００
２０２０．２
![\"\"](\"dummy_image.png\")
１． スパットくん紛失・盗難時の取扱
スパットくんの紛失・盗難の際は、速やかに停止依頼処理を入力するとともに、報告書を起票します。
ＮＯ | 項目 | 内容 |
１ | 対象のスパット くん確認 | 紛失・盗難に気づいた時には、対象のスパットくんの端末識別番号を確認します。 ※盗難の場合は警察への届出も必要です。 ※紛失・盗難の場合は盗難・紛失事故報告も必要です。 あいリクエスト（総務室（大阪）） 『盗難・紛失事故兼個人情報等事故報告』 |
２ | 報告書の起票 | あいリクエスト（システム業務室）-『モバイル決済端末（スパットくん）紛失・盗難報告書』を起票します。 |
３ | 停止依頼入力 | モバイル端末管理ウェブより停止依頼処理を入力します。 ※停止依頼入力により該当スパットくんは使用不可となります。 |
４ | 報告書の承認と 担当室への報告 | 所属長はあいリクエストにて申請・送付された報告書を確認・承認します。承認後、報告書をあいリクエスト（総務室（大阪））－『紛失・盗難事故 兼 個人情報等事故報告』に添付し報告します。（関連細則：本支社編11110／210060「紛失・盗難事故等の被害報告」を参照） ※日計処理の実施が「無」の場合本社担当室（システム業務室、 契約審査室、収納サービス室、損保サービス室）へ連絡する。 |
【関連マニュアル】 スパットくん・モバイル管理ウェブ操作マニュアル
＜スパットくん再発見時の対応＞
ＮＯ | 項目 | 内容 |
１ | 端末設置組織の 確認 | スパットくんの設置状況照会を行い、紛失・盗難となったスパットくんであるか確認します。 |
２ | 端末停止解除 入力 | モバイル端末管理ウェブより停止解除処理を入力します。 ※スパットくんの利用再開は、支社にて停止解除入力から２営業日以上経過してから利用下さい。 |
【関連マニュアル】 スパットくん・モバイル管理ウェブ操作マニュアル
２． スパットくん故障時の取扱
スパットくんが故障した場合には、代替機への交換と故障機の返却を行います。
ＮＯ | 項目 | 内容 |
１ | 故障内容の確認と報告書の起票 | スパットくんが故障した場合は、あいリクエスト（システム業務室）-『モバイル決済端末（スパットくん）故障報告書』を起票します。 |
２ | 修理依頼入力
| 『モバイル端末管理ウェブ』より修理依頼処理を入力します。修理 依頼処理の入力により、代替機が送付されます。 |
３ | 報告書の承認と担当室への報告 | 所属長はあいリクエストにて申請・送付された報告書を確認・承認し、システム業務室に報告します。 |
４ | 梱包 | 以下をセットで梱包します。 ・故障したスパットくん本体 ・付属品（充電アダプタ、コード、タッチペン、ストラップ） ・モバイル決済端末修理依頼書 ※各所属にて保管のスパットくん送付箱に梱包します
|
５ | 代替機の受取と 故障機の送付
| 入力後数日でスパットくんの代替機が到着します。 受け取ると同時に、配送業者（日本通運）に故障したスパットくん、および「モバイル決済端末修理依頼書」を渡します。 ※「モバイル決済端末修理依頼書」を忘れずに同梱下さい。
|
６ | 代替機の端末受取入力 | モバイル端末管理ウェブより代替機の端末受取処理を入力します。 |
【関連マニュアル】 スパットくん・モバイル管理ウェブ操作マニュアル
- 1 -
{text}
\"\n return f\"