@githits/mcp 0.29.0 → 0.31.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -19,6 +19,32 @@ declare function buildMcpQuickStart(options?: BuildMcpQuickStartOptions): string
19
19
  */
20
20
  declare function buildMcpInstructions(options?: BuildMcpInstructionsOptions): string;
21
21
  import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
22
+ interface AgenticAskQuestion {
23
+ question: string;
24
+ }
25
+ type AgenticAskSubject = {
26
+ target?: string;
27
+ threadId?: never;
28
+ } | {
29
+ target?: never;
30
+ threadId: string;
31
+ };
32
+ type AgenticAskRequest = AgenticAskQuestion & AgenticAskSubject & {
33
+ sourceFormat?: "cli" | "mcp" | "url";
34
+ };
35
+ interface AgenticAskRequestOptions {
36
+ signal?: AbortSignal;
37
+ }
38
+ /** Expected backend envelope; successful JSON is deliberately not runtime-validated. */
39
+ interface AgenticAskResponse {
40
+ display_markdown: string;
41
+ tool_call_id?: string;
42
+ thread_id?: string;
43
+ [key: string]: unknown;
44
+ }
45
+ interface AgenticAskService {
46
+ ask(request: AgenticAskRequest, options?: AgenticAskRequestOptions): Promise<AgenticAskResponse>;
47
+ }
22
48
  declare const registryMap: {
23
49
  readonly npm: "NPM";
24
50
  readonly pypi: "PYPI";
@@ -1029,10 +1055,10 @@ interface PackageVulnerabilitiesParams {
1029
1055
  includeTransitive?: boolean;
1030
1056
  /** Optional internal breadth for advisory-wide transitive detail fields. */
1031
1057
  includeTransitiveAdvisoryDetails?: boolean;
1032
- /** Advisory rows to return for the root and opt-in transitive audit; direct counts always include all scopes. */
1058
+ /** Advisory rows to return. Summary counts always include all scopes. */
1033
1059
  advisoryScope?: VulnerabilityScope;
1034
1060
  }
1035
- type VulnerabilityScope = "AFFECTED" | "NON_AFFECTING" | "ALL";
1061
+ type VulnerabilityScope = "AFFECTED" | "NON_AFFECTING" | "UNKNOWN" | "ALL";
1036
1062
  interface PackageVersionIdentity {
1037
1063
  name: string;
1038
1064
  registry?: string;
@@ -1056,10 +1082,14 @@ interface VulnerabilityDetail {
1056
1082
  aliases?: string[];
1057
1083
  isMalicious?: boolean;
1058
1084
  affectsInspectedVersion?: boolean;
1085
+ assessmentStatus?: string;
1086
+ assessmentReasons?: string[];
1059
1087
  matchedAffectedVersionRanges?: string[];
1060
1088
  duplicateIds?: string[];
1061
1089
  }
1062
1090
  interface VulnerabilitySecurityDetails {
1091
+ unknownVulnerabilityCount?: number;
1092
+ assessmentStatus?: string;
1063
1093
  affectedVulnerabilityCount: number;
1064
1094
  nonAffectingVulnerabilityCount: number;
1065
1095
  allVulnerabilityCount: number;
@@ -1072,7 +1102,13 @@ interface VulnerabilityReport {
1072
1102
  security?: VulnerabilitySecurityDetails;
1073
1103
  transitive?: TransitiveVulnerabilityAudit;
1074
1104
  }
1075
- interface TransitiveVulnerabilityAudit {
1105
+ interface TransitiveVulnerabilityAuditCounts {
1106
+ affectedCount: number;
1107
+ nonAffectingCount: number;
1108
+ unknownCount: number;
1109
+ totalCount: number;
1110
+ }
1111
+ interface TransitiveVulnerabilityAudit extends TransitiveVulnerabilityAuditCounts {
1076
1112
  /** Advisory scope applied to dependency-package occurrences. */
1077
1113
  advisoryScope: VulnerabilityScope;
1078
1114
  /** Number of resolved package-version graph nodes checked. */
@@ -1084,7 +1120,7 @@ interface TransitiveVulnerabilityAudit {
1084
1120
  calculatedAt?: string;
1085
1121
  packages: TransitiveVulnerabilityAuditPackage[];
1086
1122
  }
1087
- interface TransitiveVulnerabilityAuditPackage {
1123
+ interface TransitiveVulnerabilityAuditPackage extends TransitiveVulnerabilityAuditCounts {
1088
1124
  registry: string;
1089
1125
  name: string;
1090
1126
  occurrenceCount: number;
@@ -1134,8 +1170,9 @@ interface PackageUpgradeReviewPackageParams {
1134
1170
  targetVersion: string;
1135
1171
  }
1136
1172
  interface PackageUpgradeReviewParams {
1137
- /** Select complete statement text only when the caller consumes it. */
1138
- includeChangelogFullText?: boolean;
1173
+ /** Host projection; compact batch text skips statement retrieval entirely. */
1174
+ changelogView?: "text" | "json" | "triage";
1175
+ statementTiers?: ChangelogStatementTier[];
1139
1176
  packages: PackageUpgradeReviewPackageParams[];
1140
1177
  includeTransitiveSecurity: boolean;
1141
1178
  includeDependencyIssues: boolean;
@@ -1143,6 +1180,8 @@ interface PackageUpgradeReviewParams {
1143
1180
  minSeverity?: number;
1144
1181
  }
1145
1182
  interface PackageUpgradeAdvisorySummary {
1183
+ assessmentStatus?: string;
1184
+ assessmentReasons?: string[];
1146
1185
  id?: string;
1147
1186
  aliases: string[];
1148
1187
  summary?: string;
@@ -1152,6 +1191,8 @@ interface PackageUpgradeAdvisorySummary {
1152
1191
  isMalicious?: boolean;
1153
1192
  }
1154
1193
  interface PackageUpgradeVersionVulnerabilitySummary {
1194
+ unknownVulnerabilityCount?: number;
1195
+ assessmentStatus?: string;
1155
1196
  version: string;
1156
1197
  publishedAt?: string;
1157
1198
  deprecated?: boolean;
@@ -1207,48 +1248,28 @@ interface PackageUpgradeChangelogEntry {
1207
1248
  headline?: string;
1208
1249
  signals: string[];
1209
1250
  }
1210
- /** Backend model labels for one release-note statement, never a package verdict. */
1211
- interface PackageUpgradeChangelogRiskItem {
1212
- version: string;
1213
- tier: "MUST_ACT" | "SHOULD_KNOW" | "UNCLASSIFIED";
1214
- /** Backend ambiguity policy; confidence is evidence, not a client threshold. */
1215
- ambiguous: boolean;
1216
- tierConfidence?: number;
1217
- kind?: string;
1218
- kindConfidence?: number;
1219
- text: string;
1220
- textTruncated: boolean;
1221
- /** Complete statement, present only when selected. */
1222
- fullText?: string;
1223
- /** Exact backend source locator, independent of sampled entries. */
1224
- url?: string;
1225
- heading?: string;
1226
- source?: string;
1227
- model: string;
1228
- formulation: string;
1229
- }
1230
- interface PackageUpgradeChangelogRiskCoverage {
1251
+ interface ChangelogRiskCoverage {
1231
1252
  versionsClassified: number;
1232
1253
  versionsNotAssessed: number;
1233
1254
  versionsWithoutNotes: number;
1234
1255
  versionsUnparseable: number;
1235
1256
  unitsNoImpact: number;
1236
- /** Statement totals before the per-review cap, separated by backend ambiguity. */
1257
+ /** Whole-range statement totals, separated by backend ambiguity. */
1237
1258
  itemsMustActConfident: number;
1238
1259
  itemsMustActAmbiguous: number;
1239
1260
  itemsShouldKnowConfident: number;
1240
1261
  itemsShouldKnowAmbiguous: number;
1241
1262
  itemsUnclassified: number;
1242
- itemsOmitted: number;
1243
1263
  }
1264
+ interface PackageUpgradeChangelogRiskCoverage extends ChangelogRiskCoverage {}
1244
1265
  interface PackageUpgradeChangelog {
1245
- riskItems: PackageUpgradeChangelogRiskItem[];
1266
+ statements?: ChangelogStatements;
1246
1267
  riskCoverage: PackageUpgradeChangelogRiskCoverage;
1247
1268
  source?: string;
1248
1269
  fallback?: string;
1249
- entries: PackageUpgradeChangelogEntry[];
1250
- sampledEntries: PackageUpgradeChangelogEntry[];
1251
- keywordEntries: PackageUpgradeChangelogEntry[];
1270
+ entries?: PackageUpgradeChangelogEntry[];
1271
+ sampledEntries?: PackageUpgradeChangelogEntry[];
1272
+ keywordEntries?: PackageUpgradeChangelogEntry[];
1252
1273
  totalKeywordEntries: number;
1253
1274
  totalEntries: number;
1254
1275
  totalEntriesWithBodies: number;
@@ -1287,6 +1308,12 @@ interface PackageUpgradeDependencyIssues {
1287
1308
  introducedConflicts: string[];
1288
1309
  introducedOutdated: string[];
1289
1310
  }
1311
+ interface PackageUpgradeUnknownEvidence {
1312
+ section: string;
1313
+ code: string;
1314
+ message: string;
1315
+ retryable?: boolean;
1316
+ }
1290
1317
  interface PackageUpgradeReview {
1291
1318
  registry: string;
1292
1319
  name: string;
@@ -1299,7 +1326,9 @@ interface PackageUpgradeReview {
1299
1326
  compatibility?: PackageUpgradeCompatibility;
1300
1327
  dependencyChanges?: PackageUpgradeDependencyChanges;
1301
1328
  dependencyIssues?: PackageUpgradeDependencyIssues;
1329
+ /** Compatibility field derived from unknownDetails, never selected separately. */
1302
1330
  unknowns: string[];
1331
+ unknownDetails?: PackageUpgradeUnknownEvidence[];
1303
1332
  }
1304
1333
  interface PackageUpgradeReviewResponse {
1305
1334
  summary: {
@@ -1419,6 +1448,8 @@ interface VulnerabilitySummaryDetail {
1419
1448
  isMalicious?: boolean;
1420
1449
  }
1421
1450
  interface TransitiveDependencyVulnerability {
1451
+ assessmentStatus?: string;
1452
+ assessmentReasons?: string[];
1422
1453
  version: string;
1423
1454
  affectsResolvedVersion: boolean;
1424
1455
  matchedAffectedVersionRanges: string[];
@@ -1548,8 +1579,11 @@ interface PackageChangelogParams {
1548
1579
  toVersion?: string;
1549
1580
  /** Latest-mode cap (1–50). Rejected client-side when `fromVersion` is set. */
1550
1581
  limit?: number;
1551
- /** Include raw markdown bodies in entries. Defaults to true. */
1552
- includeBodies?: boolean;
1582
+ /** Default: complete parsed statements. Original notes and timeline do no label work. */
1583
+ view?: PackageChangelogView;
1584
+ statementTiers?: ChangelogStatementTier[];
1585
+ /** Select full statement text and classification provenance for machine consumers. */
1586
+ includeJsonFields?: boolean;
1553
1587
  }
1554
1588
  /**
1555
1589
  * Package-info echo from the changelog response. Mirrors
@@ -1573,12 +1607,60 @@ interface ChangelogEntryDetail {
1573
1607
  /** Present for exact selected-release results. */
1574
1608
  hasChangelog?: boolean;
1575
1609
  }
1610
+ type PackageChangelogView = "statements" | "verbatim" | "timeline";
1611
+ type ChangelogStatementTier = "MUST_ACT" | "SHOULD_KNOW" | "NO_IMPACT" | "UNCLASSIFIED";
1612
+ type ChangelogStatementAssessmentStatus = "CLASSIFIED" | "NOT_ASSESSED" | "WITHOUT_NOTES" | "UNPARSEABLE";
1613
+ interface ChangelogStatementClassification {
1614
+ tier: ChangelogStatementTier;
1615
+ ambiguous: boolean;
1616
+ kind?: string;
1617
+ tierConfidence?: number;
1618
+ kindConfidence?: number;
1619
+ model?: string;
1620
+ formulation?: string;
1621
+ }
1622
+ interface ChangelogStatementContext {
1623
+ heading?: string;
1624
+ text: string;
1625
+ textTruncated: boolean;
1626
+ fullText?: string;
1627
+ }
1628
+ interface ChangelogStatement {
1629
+ version: string;
1630
+ position: number;
1631
+ sourceIndex: number;
1632
+ sourcePosition?: number;
1633
+ heading?: string;
1634
+ source?: string;
1635
+ url?: string;
1636
+ text: string;
1637
+ textTruncated: boolean;
1638
+ fullText?: string;
1639
+ context?: ChangelogStatementContext;
1640
+ /** Null is missing assessment, never a no-impact classification. */
1641
+ classification: ChangelogStatementClassification | null;
1642
+ }
1643
+ interface ChangelogStatementCoverage {
1644
+ version: string;
1645
+ status: ChangelogStatementAssessmentStatus;
1646
+ statementsTotal: number;
1647
+ statementsAssessed: number;
1648
+ statementsNotAssessed: number;
1649
+ statementsNoImpact: number;
1650
+ statementsUnclassified: number;
1651
+ }
1652
+ interface ChangelogStatements {
1653
+ totalCount: number;
1654
+ matchingCount: number;
1655
+ items: ChangelogStatement[];
1656
+ coverage: ChangelogStatementCoverage[];
1657
+ }
1576
1658
  interface ChangelogReport {
1577
- /** Echo of addressing + filter as the backend saw it. */
1659
+ statements?: ChangelogStatements;
1660
+ /** Optional legacy addressing echo; hosts already know the request identity. */
1578
1661
  package?: ChangelogPackageInfo;
1579
- /** `"releases"` | `"changelog_file"` | `"hexdocs"` when resolved; absent for package versions with no changelog entry. */
1580
1662
  source?: string;
1581
- /** Entries in backend/source order. Empty array = resolved source but nothing in range. */
1663
+ /** Entries in backend/source order. */
1582
1664
  entries: ChangelogEntryDetail[];
1583
1665
  }
1584
1666
  type PackageDocSourceKind = "CRAWLED" | "REPOSITORY";
@@ -1860,6 +1942,8 @@ interface McpToolServices {
1860
1942
  readService: ReadService;
1861
1943
  grepService: GrepService;
1862
1944
  resolveTargetService: ResolveTargetService;
1945
+ /** Research over the GitHits REST API; answers can take a few minutes. */
1946
+ agenticAskService: AgenticAskService;
1863
1947
  }
1864
1948
  interface McpServerMetadata {
1865
1949
  name: string;