# ToolArgumentsValidationResult

> Tracon documentation. Tracon is a .NET package family that adds a control
> plane on Microsoft Agent Framework, published as NuGet packages that run
> inside your own ASP.NET Core application.
>
> Page: https://tracon.dev/api/tracon.toolargumentsvalidationresult/
> Summary: ToolArgumentsValidationResult: The outcome of a tool arguments validation check.

<div class="api-provenance">Namespace Tracon · Assembly <code>Tracon.Abstractions.dll</code></div>

The outcome of a tool arguments validation check.

```csharp
public sealed record ToolArgumentsValidationResult : IEquatable<ToolArgumentsValidationResult>
```

<dl class="api-relations"><dt>Inheritance</dt><dd><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ← <a href="/api/tracon.toolargumentsvalidationresult/">ToolArgumentsValidationResult</a></dd><dt>Implements</dt><dd><a href="https://learn.microsoft.com/dotnet/api/system.iequatable-1">IEquatable&lt;ToolArgumentsValidationResult&gt;</a></dd><dt>Inherited Members</dt><dd><a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>, <a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>, <a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>, <a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>, <a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>, <a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a></dd></dl>

## Properties

### <a id="Tracon_ToolArgumentsValidationResult_IsValid"></a> IsValid

Gets whether the call's arguments are valid.

```csharp
public bool IsValid { get; }
```

#### Property Value

 [bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### <a id="Tracon_ToolArgumentsValidationResult_Reason"></a> Reason

Gets the reason shown to the model when the call is rejected.
[null](https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null) when [ToolArgumentsValidationResult.IsValid](/api/tracon.toolargumentsvalidationresult/#Tracon_ToolArgumentsValidationResult_IsValid) is [true](https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool).

```csharp
public string? Reason { get; }
```

#### Property Value

 [string](https://learn.microsoft.com/dotnet/api/system.string)?

#### Remarks

This text is sent to the model, not shown to the user directly. It
must never carry an argument **value** — a rejected
call's record is written to a persistent run event, and an argument
can carry a `secret`.

### <a id="Tracon_ToolArgumentsValidationResult_Valid"></a> Valid

A result allowing the call.

```csharp
public static ToolArgumentsValidationResult Valid { get; }
```

#### Property Value

 [ToolArgumentsValidationResult](/api/tracon.toolargumentsvalidationresult/)

## Methods

### <a id="Tracon_ToolArgumentsValidationResult_Equals_System_Object_"></a> Equals\(object?\)

```csharp
public override bool Equals(object? obj)
```

#### Parameters

`obj` [object](https://learn.microsoft.com/dotnet/api/system.object)?

#### Returns

 [bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### <a id="Tracon_ToolArgumentsValidationResult_Equals_Tracon_ToolArgumentsValidationResult_"></a> Equals\(ToolArgumentsValidationResult?\)

```csharp
public bool Equals(ToolArgumentsValidationResult? other)
```

#### Parameters

`other` [ToolArgumentsValidationResult](/api/tracon.toolargumentsvalidationresult/)?

#### Returns

 [bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### <a id="Tracon_ToolArgumentsValidationResult_GetHashCode"></a> GetHashCode\(\)

```csharp
public override int GetHashCode()
```

#### Returns

 [int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="Tracon_ToolArgumentsValidationResult_Invalid_System_String_"></a> Invalid\(string\)

Creates a result that rejects the call.

```csharp
public static ToolArgumentsValidationResult Invalid(string reason)
```

#### Parameters

`reason` [string](https://learn.microsoft.com/dotnet/api/system.string)

The reason shown to the model. Must not carry argument values.

#### Returns

 [ToolArgumentsValidationResult](/api/tracon.toolargumentsvalidationresult/)

A rejecting result.

#### Exceptions

 [ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)

`reason` is empty or whitespace.

### <a id="Tracon_ToolArgumentsValidationResult_ToString"></a> ToString\(\)

```csharp
public override string ToString()
```

#### Returns

 [string](https://learn.microsoft.com/dotnet/api/system.string)

## Operators

### <a id="Tracon_ToolArgumentsValidationResult_op_Equality_Tracon_ToolArgumentsValidationResult_Tracon_ToolArgumentsValidationResult_"></a> operator ==\(ToolArgumentsValidationResult?, ToolArgumentsValidationResult?\)

```csharp
public static bool operator ==(ToolArgumentsValidationResult? left, ToolArgumentsValidationResult? right)
```

#### Parameters

`left` [ToolArgumentsValidationResult](/api/tracon.toolargumentsvalidationresult/)?

`right` [ToolArgumentsValidationResult](/api/tracon.toolargumentsvalidationresult/)?

#### Returns

 [bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### <a id="Tracon_ToolArgumentsValidationResult_op_Inequality_Tracon_ToolArgumentsValidationResult_Tracon_ToolArgumentsValidationResult_"></a> operator \!=\(ToolArgumentsValidationResult?, ToolArgumentsValidationResult?\)

```csharp
public static bool operator !=(ToolArgumentsValidationResult? left, ToolArgumentsValidationResult? right)
```

#### Parameters

`left` [ToolArgumentsValidationResult](/api/tracon.toolargumentsvalidationresult/)?

`right` [ToolArgumentsValidationResult](/api/tracon.toolargumentsvalidationresult/)?

#### Returns

 [bool](https://learn.microsoft.com/dotnet/api/system.boolean)