Class FtpTestTool
A built-in tool for testing the connection to an FTP server.
Connects to the server, retrieves the system type and current working directory, and measures the elapsed time. Useful for verifying credentials and connectivity before performing other operations.
public sealed class FtpTestTool : IBuiltInTool, ITool, IToolMetadata
- Inheritance
-
FtpTestTool
- Implements
- Inherited Members
Examples
var test = new FtpTestTool(new FtpToolOptions
{
Host = "ftp.example.com",
Username = "user",
Password = "pass"
});
Constructors
- FtpTestTool()
Initializes a new instance with default options.
- FtpTestTool(FtpToolOptions)
Initializes a new instance with the specified options.
Properties
- Description
Gets a concise description of what the tool does.
- InputSchema
Gets the JSON Schema defining the expected input arguments.
- Name
Gets the stable, unique identifier for this tool.
Methods
- InvokeAsync(string, CancellationToken)
Executes the tool with the specified JSON arguments.