larksuite/cli · error

Metadata.Description is required

Error message

Metadata.Description is required

What it means

Compile-time guard in validateCommandMetadata: Metadata.Description is empty or whitespace-only; shortcuts must document their purpose.

Source

Thrown at shortcuts/common/typed_compiler.go:110

	}
	if service != string(metadata.Service) || strings.ContainsAny(service, " \t\r\n/") {
		return fmt.Errorf("Metadata.Service %q must be one trimmed command segment", metadata.Service)
	}
	command := strings.TrimSpace(metadata.Command)
	if command == "" {
		return fmt.Errorf("Metadata.Command is required")
	}
	if command != metadata.Command || strings.ContainsAny(command, " \t\r\n/") {
		return fmt.Errorf("Metadata.Command %q must be one trimmed command segment", metadata.Command)
	}
	if !strings.HasPrefix(command, "+") {
		return fmt.Errorf("Metadata.Command %q must start with '+'", metadata.Command)
	}
	if command == "+" {
		return fmt.Errorf("Metadata.Command must contain a name after '+'")
	}
	if strings.TrimSpace(metadata.Description) == "" {
		return fmt.Errorf("Metadata.Description is required")
	}
	switch metadata.Risk {
	case typedRiskRead, typedRiskWrite, typedRiskHighRiskWrite:
	default:
		return fmt.Errorf("Metadata.Risk %q is invalid", metadata.Risk)
	}
	if len(metadata.Authorization.Identities) == 0 {
		return fmt.Errorf("Metadata.Authorization.Identities must declare at least one identity")
	}
	for identity, auth := range metadata.Authorization.Identities {
		if identity != typedIdentityUser && identity != typedIdentityBot {
			return fmt.Errorf("Metadata.Authorization identity %q is invalid", identity)
		}
		if err := validateScopeList(auth.RequiredScopes, fmt.Sprintf("Authorization.%s.RequiredScopes", identity)); err != nil {
			return err
		}
		requiredScopes := make(map[string]struct{}, len(auth.RequiredScopes))
		for _, scope := range auth.RequiredScopes {

View on GitHub (pinned to 7fd6ef3c07)

Solutions

1. Write a non-empty Metadata.Description

When it happens

Trigger: Thrown at shortcuts/common/typed_compiler.go:110 when the library encounters an invalid state.

Common situations: See trigger scenarios.

AI-assisted analysis of larksuite/cli@7fd6ef3c07 (2026-09-04). Data as JSON: /api/errors/b791d417c2c81f09. Report an issue: GitHub.