FilesExpand file tree

main

/

secret_scanning.go

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

205 lines (190 loc) · 6.47 KB

main

/

secret_scanning.go

Copy path

Top

File metadata and controls

• Code
• Blame

205 lines (190 loc) · 6.47 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

package github

import (

"context"

"encoding/json"

"fmt"

"io"

"net/http"

ghErrors "github.com/github/github-mcp-server/pkg/errors"

"github.com/github/github-mcp-server/pkg/inventory"

"github.com/github/github-mcp-server/pkg/scopes"

"github.com/github/github-mcp-server/pkg/translations"

"github.com/github/github-mcp-server/pkg/utils"

"github.com/google/go-github/v87/github"

"github.com/google/jsonschema-go/jsonschema"

"github.com/modelcontextprotocol/go-sdk/mcp"

)

func GetSecretScanningAlert(t translations.TranslationHelperFunc) inventory.ServerTool {

return NewTool(

ToolsetMetadataSecretProtection,

mcp.Tool{

Name: "get_secret_scanning_alert",

Description: t("TOOL_GET_SECRET_SCANNING_ALERT_DESCRIPTION", "Get details of a specific secret scanning alert in a GitHub repository."),

Annotations: &mcp.ToolAnnotations{

Title: t("TOOL_GET_SECRET_SCANNING_ALERT_USER_TITLE", "Get secret scanning alert"),

ReadOnlyHint: true,

},

InputSchema: &jsonschema.Schema{

Type: "object",

Properties: map[string]*jsonschema.Schema{

"owner": {

Type: "string",

Description: "The owner of the repository.",

},

"repo": {

Type: "string",

Description: "The name of the repository.",

},

"alertNumber": {

Type: "number",

Description: "The number of the alert.",

},

},

Required: []string{"owner", "repo", "alertNumber"},

},

},

[]scopes.Scope{scopes.SecurityEvents},

func(ctx context.Context, deps ToolDependencies, _ *mcp.CallToolRequest, args map[string]any) (*mcp.CallToolResult, any, error) {

owner, err := RequiredParam[string](args, "owner")

if err != nil {

return utils.NewToolResultError(err.Error()), nil, nil

}

repo, err := RequiredParam[string](args, "repo")

if err != nil {

return utils.NewToolResultError(err.Error()), nil, nil

}

alertNumber, err := RequiredInt(args, "alertNumber")

if err != nil {

return utils.NewToolResultError(err.Error()), nil, nil

}

client, err := deps.GetClient(ctx)

if err != nil {

return nil, nil, fmt.Errorf("failed to get GitHub client: %w", err)

}

alert, resp, err := client.SecretScanning.GetAlert(ctx, owner, repo, int64(alertNumber))

if err != nil {

return ghErrors.NewGitHubAPIErrorResponse(ctx,

fmt.Sprintf("failed to get alert with number '%d'", alertNumber),

resp,

err,

), nil, nil

}

defer func() { _ = resp.Body.Close() }()

if resp.StatusCode != http.StatusOK {

body, err := io.ReadAll(resp.Body)

if err != nil {

return nil, nil, fmt.Errorf("failed to read response body: %w", err)

}

return ghErrors.NewGitHubAPIStatusErrorResponse(ctx, "failed to get alert", resp, body), nil, nil

}

r, err := json.Marshal(alert)

if err != nil {

return nil, nil, fmt.Errorf("failed to marshal alert: %w", err)

}

return utils.NewToolResultText(string(r)), nil, nil

},

)

}

func ListSecretScanningAlerts(t translations.TranslationHelperFunc) inventory.ServerTool {

schema := &jsonschema.Schema{

Type: "object",

Properties: map[string]*jsonschema.Schema{

"owner": {

Type: "string",

Description: "The owner of the repository.",

},

"repo": {

Type: "string",

Description: "The name of the repository.",

},

"state": {

Type: "string",

Description: "Filter by state",

Enum: []any{"open", "resolved"},

},

"secret_type": {

Type: "string",

Description: "A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter.",

},

"resolution": {

Type: "string",

Description: "Filter by resolution",

Enum: []any{"false_positive", "wont_fix", "revoked", "pattern_edited", "pattern_deleted", "used_in_tests"},

},

},

Required: []string{"owner", "repo"},

}

WithPagination(schema)

return NewTool(

ToolsetMetadataSecretProtection,

mcp.Tool{

Name: "list_secret_scanning_alerts",

Description: t("TOOL_LIST_SECRET_SCANNING_ALERTS_DESCRIPTION", "List secret scanning alerts in a GitHub repository."),

Annotations: &mcp.ToolAnnotations{

Title: t("TOOL_LIST_SECRET_SCANNING_ALERTS_USER_TITLE", "List secret scanning alerts"),

ReadOnlyHint: true,

},

InputSchema: schema,

},

[]scopes.Scope{scopes.SecurityEvents},

func(ctx context.Context, deps ToolDependencies, _ *mcp.CallToolRequest, args map[string]any) (*mcp.CallToolResult, any, error) {

owner, err := RequiredParam[string](args, "owner")

if err != nil {

return utils.NewToolResultError(err.Error()), nil, nil

}

repo, err := RequiredParam[string](args, "repo")

if err != nil {

return utils.NewToolResultError(err.Error()), nil, nil

}

state, err := OptionalParam[string](args, "state")

if err != nil {

return utils.NewToolResultError(err.Error()), nil, nil

}

secretType, err := OptionalParam[string](args, "secret_type")

if err != nil {

return utils.NewToolResultError(err.Error()), nil, nil

}

resolution, err := OptionalParam[string](args, "resolution")

if err != nil {

return utils.NewToolResultError(err.Error()), nil, nil

}

pagination, err := OptionalPaginationParams(args)

if err != nil {

return utils.NewToolResultError(err.Error()), nil, nil

}

client, err := deps.GetClient(ctx)

if err != nil {

return nil, nil, fmt.Errorf("failed to get GitHub client: %w", err)

}

alerts, resp, err := client.SecretScanning.ListAlertsForRepo(ctx, owner, repo, &github.SecretScanningAlertListOptions{

State: state,

SecretType: secretType,

Resolution: resolution,

ListOptions: github.ListOptions{

Page: pagination.Page,

PerPage: pagination.PerPage,

},

})

if err != nil {

return ghErrors.NewGitHubAPIErrorResponse(ctx,

fmt.Sprintf("failed to list alerts for repository '%s/%s'", owner, repo),

resp,

err,

), nil, nil

}

defer func() { _ = resp.Body.Close() }()

if resp.StatusCode != http.StatusOK {

body, err := io.ReadAll(resp.Body)

if err != nil {

return nil, nil, fmt.Errorf("failed to read response body: %w", err)

}

return ghErrors.NewGitHubAPIStatusErrorResponse(ctx, "failed to list alerts", resp, body), nil, nil

}

r, err := json.Marshal(alerts)

if err != nil {

return nil, nil, fmt.Errorf("failed to marshal alerts: %w", err)

}

return utils.NewToolResultText(string(r)), nil, nil

},

)

}