tools

package

v0.0.391 Latest Latest Go to latest Published: Nov 10, 2026 License: Apache-2.0 Imports: 12 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/kubescape/storage

Links

Open Source Insights

Documentation ¶

Overview ¶

Package tools holds the read-only MCP tools served on the mcpservers/mcp subresource (designs-and-proposals storage-mcp-endpoint.md). They read only through Reader, so they do not depend on how the data is fetched or how the caller's access is checked.

Index ¶

func ErrorResult(code ErrorCode, message string, details map[string]any) *mcp.CallToolResult
func Register(s *server.MCPServer, r Reader)
func SizeHint(tool string) string
func WithDefaultNamespace(ctx context.Context, namespace string) context.Context
type ErrorCode
type Reader
type ToolError

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func ErrorResult ¶ added in v0.0.391

func ErrorResult(code ErrorCode, message string, details map[string]any) *mcp.CallToolResult

ErrorResult is the tool error result with code, message and details.

func Register ¶

func Register(s *server.MCPServer, r Reader)

Register adds every tool to s.

func SizeHint ¶ added in v0.0.391

func SizeHint(tool string) string

SizeHint says how to ask tool for less, for an answer above the endpoint's size cap.

func WithDefaultNamespace ¶

func WithDefaultNamespace(ctx context.Context, namespace string) context.Context

WithDefaultNamespace sets the namespace a tool uses when the call gives none.

Types ¶

type ErrorCode ¶

type ErrorCode string

ErrorCode is the code of a tool error. The codes and the ToolError shape are the ones kubescape mcpserver uses, so agents handle both the same way.

const (
	ErrCodeResourceNotFound ErrorCode = "RESOURCE_NOT_FOUND"
	ErrCodeRBACDenied       ErrorCode = "RBAC_DENIED"
	ErrCodeInvalidArgument  ErrorCode = "INVALID_ARGUMENT"
	ErrCodeTimeout          ErrorCode = "TIMEOUT"
	// ErrCodeResponseTooLarge is the answer to a call whose result is above
	// the endpoint's size cap.
	ErrCodeResponseTooLarge ErrorCode = "RESPONSE_TOO_LARGE"
)

type Reader ¶

type Reader interface {
	ListVulnerabilityManifests(ctx context.Context, namespace string, opts metav1.ListOptions) (*v1beta1.VulnerabilityManifestList, error)
	GetVulnerabilityManifest(ctx context.Context, namespace, name string) (*v1beta1.VulnerabilityManifest, error)
	ListSBOMSyfts(ctx context.Context, namespace string, opts metav1.ListOptions) (*v1beta1.SBOMSyftList, error)
	GetSBOMSyft(ctx context.Context, namespace, name string) (*v1beta1.SBOMSyft, error)
	ListWorkloadConfigurationScans(ctx context.Context, namespace string, opts metav1.ListOptions) (*v1beta1.WorkloadConfigurationScanList, error)
	GetWorkloadConfigurationScan(ctx context.Context, namespace, name string) (*v1beta1.WorkloadConfigurationScan, error)
	ListContainerProfiles(ctx context.Context, namespace string, opts metav1.ListOptions) (*v1beta1.ContainerProfileList, error)
	GetContainerProfile(ctx context.Context, namespace, name string) (*v1beta1.ContainerProfile, error)
}

Reader is what the tools read from. A denied read returns a Forbidden error, as the Kubernetes API does.

type ToolError ¶

type ToolError struct {
	Code    ErrorCode      `json:"code"`
	Message string         `json:"message"`
	Details map[string]any `json:"details,omitempty"`
}

ToolError is the JSON text of a tool error result.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL