MeshAgent Tools
The meshagent.tools package bundles reusable tool and toolkit abstractions plus a set of out of the box MeshAgent toolkits.
ToolContext and BaseTool
The ToolContext tracks the room, caller, and optional "on-behalf-of" participant. The BaseTool defines metadata used by all tools such as name and description.
Tool and Toolkit
A Tool encapsulates a single operation with an input JSON schema. Each tool implements an execute function where you define the logic for the tool. The Toolkit groups tools together and can enforce rules or descriptions.
Response Types
Response types specify the output that a tool should return. This helps the tool and agent know how to handle the response appropriately. Response types include: JsonResponse, TextResponse, and FileResponse.
from meshagent.tools import Tool, Toolkit, ToolContext
from meshagent.api.messaging import TextResponse
class MyNewTool(Tool):
def __init__(self):
super().__init__(
name="my_new_tool",
title="A sample tool",
description="The tool skeleton",
input_schema={
"type":"object",
"additionalProperties": False,
"required": [...],
"properties": {...}
}
)
async def execute(self, ctx:ToolContext, sample_parameter:str):
# tool logic
return TextResponse(text="Tool logic complete")
class MyNewToolkit(Toolkit):
def __init__(self):
super().__init__(
name="my_new_toolkit",
title="An example toolkit",
description="The toolkit skeleton",
tools=[MyNewTool])
Built-in Toolkits
Some of the built-in MeshAgent toolkits include:
StorageToolkit: Provides file operations (read, write, list, etc.)DocumentAuthoringToolkit: Defines tools for manipulating Mesh documents (create document, add element, remove element, etc.)
Learn more about MeshAgent on our website or check out the docs for additional examples!
Website: www.meshagent.com
Documentation: docs.meshagent.com
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file meshagent_tools-0.4.1.tar.gz.
File metadata
- Download URL: meshagent_tools-0.4.1.tar.gz
- Upload date:
- Size: 18.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a64b296723f4cf0f67f339896d3f8cb0cf46d7c6bf2960421d06ae45850fc5cc
|
|
| MD5 |
5faf2f05540a5d2a91ad1629a92571a7
|
|
| BLAKE2b-256 |
9798b56dfa1e3bd10319e94d1b971d61e4883b84cc041d99f276be6371b6f926
|
File details
Details for the file meshagent_tools-0.4.1-py3-none-any.whl.
File metadata
- Download URL: meshagent_tools-0.4.1-py3-none-any.whl
- Upload date:
- Size: 21.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3d83a4755f3002cbf5c6e5c58badc2251a62549cbad2c6870caa7b3a62041465
|
|
| MD5 |
67c14bddbaf44435a2a089758fa89fb1
|
|
| BLAKE2b-256 |
4ad36bd23027ca69f4028edcd67aa94b2c5a8333b038eb9aa573332e7e8f0320
|
