@githits/mcp 0.25.1 → 0.26.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/README.md +17 -0
- package/dist/client.d.ts +1 -1
- package/dist/client.js +1 -1
- package/dist/index.d.ts +164 -43
- package/dist/index.js +40 -24
- package/dist/shared/{chunk-wsqppssk.js → chunk-fy8ypkev.js} +1 -1
- package/dist/shared/chunk-vhhae3y9.js +2 -0
- package/dist/shared/{chunk-ge2panr3.js → chunk-yxxmv1b1.js} +3 -3
- package/dist/smoke-test.d.ts +1 -1
- package/dist/smoke-test.js +3 -3
- package/dist/tools.js +1 -1
- package/package.json +1 -1
- package/dist/shared/chunk-q07qg1z9.js +0 -2
package/README.md
CHANGED
|
@@ -18,6 +18,23 @@ update and deployment rather than through a parallel implementation.
|
|
|
18
18
|
> filesystem access, authentication implementation or storage, configuration
|
|
19
19
|
> discovery, or any other host behavior.
|
|
20
20
|
|
|
21
|
+
## Stable Source Diff
|
|
22
|
+
|
|
23
|
+
The public tool inventory includes `code_diff` by default. It compares raw
|
|
24
|
+
repository trees across exact package versions or public repository refs;
|
|
25
|
+
package addressing does not filter to a package subdirectory. Defaults are
|
|
26
|
+
bounded name-status inventory and text, with scoped stats/patches available.
|
|
27
|
+
Truncation and content-safety limits remain evidence limits; a diff does not
|
|
28
|
+
establish upgrade compatibility.
|
|
29
|
+
|
|
30
|
+
Custom service providers must supply `codeNavigationService` implementing both
|
|
31
|
+
`CodeNavigationService` and `CodeDiffService`. Import those contracts from
|
|
32
|
+
`@githits/mcp/client`; the built-in `CodeNavigationServiceImpl` already
|
|
33
|
+
implements both. Providers implementing only navigation must add `codeDiff`
|
|
34
|
+
before adopting this package version. The standalone `CodeNavigationService`
|
|
35
|
+
interface remains unchanged. The separate hosted server must adopt and deploy
|
|
36
|
+
the released package before hosted clients receive the tool.
|
|
37
|
+
|
|
21
38
|
## API
|
|
22
39
|
|
|
23
40
|
- `createMcpServer(options)` creates an MCP server with GitHits tools registered.
|
package/dist/client.d.ts
CHANGED
|
@@ -1090,7 +1090,7 @@ interface ListParams {
|
|
|
1090
1090
|
}
|
|
1091
1091
|
type ListInventoryKind = "SOURCE" | "SITE";
|
|
1092
1092
|
type ListEntryKind = "FILE" | "PAGE" | "DIRECTORY";
|
|
1093
|
-
type ListSiteWaitOutcome = "COMPLETED" | "DISCARDED" | "CANCELLED" | "TIMEOUT";
|
|
1093
|
+
type ListSiteWaitOutcome = "COMPLETED" | "DISCARDED" | "CANCELLED" | "TIMEOUT" | "FAILED" | "SUPERSEDED";
|
|
1094
1094
|
interface ListReadAction {
|
|
1095
1095
|
target: string;
|
|
1096
1096
|
path: string | null;
|
package/dist/client.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
import{DEFAULT_MCP_URL2,DEFAULT_API_URL2,DEFAULT_CODE_NAV_URL2,getMcpUrl2,getApiUrl2,getCodeNavigationUrl2,getEnvApiToken2,GitHitsServiceImpl2,PKGSEER_REGISTRY_LIST2,toPkgseerRegistry2,toPkgseerRegistryLowercase2,CodeDiffError2,CodeNavigationServiceImpl2,GrepGraphQLError2,GrepBackendError2,GrepAccessError2,GrepNetworkError2,MalformedGrepResponseError2,GrepServiceImpl2,ListAccessError2,ListGraphQLError2,ListBackendError2,ListNetworkError2,MalformedListResponseError2,ListServiceImpl2,PackageIntelligenceServiceImpl2,ReadServiceImpl2,RefreshingGitHitsService2,createStaticTokenProvider2,SessionIdConfigError2,getEnvSessionId2,createClientHeaderBuilder2}from"./shared/chunk-
|
|
1
|
+
import{DEFAULT_MCP_URL2,DEFAULT_API_URL2,DEFAULT_CODE_NAV_URL2,getMcpUrl2,getApiUrl2,getCodeNavigationUrl2,getEnvApiToken2,GitHitsServiceImpl2,PKGSEER_REGISTRY_LIST2,toPkgseerRegistry2,toPkgseerRegistryLowercase2,CodeDiffError2,CodeNavigationServiceImpl2,GrepGraphQLError2,GrepBackendError2,GrepAccessError2,GrepNetworkError2,MalformedGrepResponseError2,GrepServiceImpl2,ListAccessError2,ListGraphQLError2,ListBackendError2,ListNetworkError2,MalformedListResponseError2,ListServiceImpl2,PackageIntelligenceServiceImpl2,ReadServiceImpl2,RefreshingGitHitsService2,createStaticTokenProvider2,SessionIdConfigError2,getEnvSessionId2,createClientHeaderBuilder2}from"./shared/chunk-yxxmv1b1.js";export{CodeDiffError2 as CodeDiffError,CodeNavigationServiceImpl2 as CodeNavigationServiceImpl,DEFAULT_API_URL2 as DEFAULT_API_URL,DEFAULT_CODE_NAV_URL2 as DEFAULT_CODE_NAV_URL,DEFAULT_MCP_URL2 as DEFAULT_MCP_URL,GitHitsServiceImpl2 as GitHitsServiceImpl,GrepAccessError2 as GrepAccessError,GrepBackendError2 as GrepBackendError,GrepGraphQLError2 as GrepGraphQLError,GrepNetworkError2 as GrepNetworkError,GrepServiceImpl2 as GrepServiceImpl,ListAccessError2 as ListAccessError,ListBackendError2 as ListBackendError,ListGraphQLError2 as ListGraphQLError,ListNetworkError2 as ListNetworkError,ListServiceImpl2 as ListServiceImpl,MalformedGrepResponseError2 as MalformedGrepResponseError,MalformedListResponseError2 as MalformedListResponseError,PKGSEER_REGISTRY_LIST2 as PKGSEER_REGISTRY_LIST,PackageIntelligenceServiceImpl2 as PackageIntelligenceServiceImpl,ReadServiceImpl2 as ReadServiceImpl,RefreshingGitHitsService2 as RefreshingGitHitsService,SessionIdConfigError2 as SessionIdConfigError,createClientHeaderBuilder2 as createClientHeaderBuilder,createStaticTokenProvider2 as createStaticTokenProvider,getApiUrl2 as getApiUrl,getCodeNavigationUrl2 as getCodeNavigationUrl,getEnvApiToken2 as getEnvApiToken,getEnvSessionId2 as getEnvSessionId,getMcpUrl2 as getMcpUrl,toPkgseerRegistry2 as toPkgseerRegistry,toPkgseerRegistryLowercase2 as toPkgseerRegistryLowercase};
|
package/dist/index.d.ts
CHANGED
|
@@ -19,47 +19,6 @@ 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
|
-
import { z } from "zod";
|
|
23
|
-
/** Annotation fields required by OpenAI's MCP marketplace validation. */
|
|
24
|
-
interface CompleteToolAnnotations {
|
|
25
|
-
title?: string;
|
|
26
|
-
readOnlyHint: boolean;
|
|
27
|
-
idempotentHint?: boolean;
|
|
28
|
-
openWorldHint: boolean;
|
|
29
|
-
destructiveHint: boolean;
|
|
30
|
-
}
|
|
31
|
-
interface McpAuthActionContext {
|
|
32
|
-
authSource: unknown;
|
|
33
|
-
defaultAction: string;
|
|
34
|
-
}
|
|
35
|
-
type McpAuthAction = string | ((context: McpAuthActionContext) => string);
|
|
36
|
-
/** Host-selected message and action for terms-acceptance failures. */
|
|
37
|
-
interface ToolTermsRemediation {
|
|
38
|
-
message: string;
|
|
39
|
-
action: string;
|
|
40
|
-
}
|
|
41
|
-
/** Host-provided execution state shared by MCP and direct tool callers. */
|
|
42
|
-
interface ToolExecutionContext {
|
|
43
|
-
authAction?: McpAuthAction;
|
|
44
|
-
termsRemediation?: ToolTermsRemediation;
|
|
45
|
-
signal?: AbortSignal;
|
|
46
|
-
}
|
|
47
|
-
/**
|
|
48
|
-
* Standard result type for all MCP tools
|
|
49
|
-
*/
|
|
50
|
-
type ToolResult = {
|
|
51
|
-
content: Array<{
|
|
52
|
-
type: "text";
|
|
53
|
-
text: string;
|
|
54
|
-
}>;
|
|
55
|
-
isError?: boolean;
|
|
56
|
-
};
|
|
57
|
-
/**
|
|
58
|
-
* Zod raw shape type (what MCP SDK expects)
|
|
59
|
-
*/
|
|
60
|
-
type ZodRawShape = {
|
|
61
|
-
[k: string]: z.ZodTypeAny;
|
|
62
|
-
};
|
|
63
22
|
declare const registryMap: {
|
|
64
23
|
readonly npm: "NPM";
|
|
65
24
|
readonly pypi: "PYPI";
|
|
@@ -530,11 +489,128 @@ interface ReadFileResult {
|
|
|
530
489
|
targetResolution?: TargetResolution;
|
|
531
490
|
availableVersions?: AvailableVersion[];
|
|
532
491
|
}
|
|
492
|
+
/**
|
|
493
|
+
* A package-addressing target for a repository-wide CodeDiff. Version
|
|
494
|
+
* resolution belongs to the comparison endpoints, so this target
|
|
495
|
+
* intentionally has no version field. Package addressing resolves repository
|
|
496
|
+
* identity and commits; it does not narrow raw file results to a package path.
|
|
497
|
+
* Target selection uses own-key presence; a `repoUrl` key rejects this shape
|
|
498
|
+
* even when its value is `undefined`.
|
|
499
|
+
*/
|
|
500
|
+
interface CodeDiffPackageTarget {
|
|
501
|
+
registry: CodeNavigationRegistry;
|
|
502
|
+
packageName: string;
|
|
503
|
+
}
|
|
504
|
+
/**
|
|
505
|
+
* A public repository target for CodeDiff. Ref resolution belongs to the
|
|
506
|
+
* comparison endpoints, so this target intentionally has no gitRef field.
|
|
507
|
+
* Target selection uses own-key presence; a `registry` or `packageName` key
|
|
508
|
+
* rejects this shape even when its value is `undefined`.
|
|
509
|
+
*/
|
|
510
|
+
interface CodeDiffRepositoryTarget {
|
|
511
|
+
repoUrl: string;
|
|
512
|
+
}
|
|
513
|
+
type CodeDiffTarget = CodeDiffPackageTarget | CodeDiffRepositoryTarget;
|
|
514
|
+
type CodeDiffMode = "inventory" | "stats" | "patches";
|
|
515
|
+
interface CodeDiffOptions {
|
|
516
|
+
maxFiles?: number;
|
|
517
|
+
maxPatchBytes?: number;
|
|
518
|
+
pathPrefix?: string;
|
|
519
|
+
pathGlob?: string;
|
|
520
|
+
}
|
|
521
|
+
interface CodeDiffParams {
|
|
522
|
+
target: CodeDiffTarget;
|
|
523
|
+
from: string;
|
|
524
|
+
to: string;
|
|
525
|
+
mode: CodeDiffMode;
|
|
526
|
+
options?: CodeDiffOptions;
|
|
527
|
+
}
|
|
528
|
+
type CodeDiffRefKind = "SHA" | "TAG" | "BRANCH" | "HEAD" | "UNKNOWN";
|
|
529
|
+
type CodeDiffVersionSource = "REGISTRY" | "GIT_HEAD" | "TAG" | "RELEASE";
|
|
530
|
+
/**
|
|
531
|
+
* Effective raw inventory scope. Current successful backends return
|
|
532
|
+
* `REPOSITORY`; `PACKAGE` and `UNKNOWN` remain accepted for compatibility with
|
|
533
|
+
* legacy responses.
|
|
534
|
+
*/
|
|
535
|
+
type RawCodeDiffScopeStatus = "PACKAGE" | "REPOSITORY" | "UNKNOWN";
|
|
536
|
+
type RawCodeDiffFileStatus = "ADDED" | "DELETED" | "MODIFIED";
|
|
537
|
+
type RawCodeDiffPathEncoding = "UTF8" | "BYTE_ESCAPED";
|
|
538
|
+
type RawCodeDiffFileContentStatus = "NOT_REQUESTED" | "STATS" | "PATCH" | "BINARY" | "METADATA_ONLY" | "OMITTED" | "UNAVAILABLE";
|
|
539
|
+
type RawCodeDiffContentCoverage = "NOT_REQUESTED" | "COMPLETE" | "PARTIAL" | "FAILED";
|
|
533
540
|
type ContentModification = "INVISIBLE_CONTROLS_STRIPPED" | "HTML_COMMENTS_STRIPPED" | "IMAGES_REPLACED" | "UNSAFE_LINKS_NEUTRALIZED";
|
|
541
|
+
interface CodeDiffPackageInfo {
|
|
542
|
+
registry: CodeNavigationRegistry;
|
|
543
|
+
name: string;
|
|
544
|
+
repoUrl: string;
|
|
545
|
+
}
|
|
546
|
+
interface CodeDiffRefResolution {
|
|
547
|
+
requested: string;
|
|
548
|
+
resolvedVersion?: string;
|
|
549
|
+
ref: string;
|
|
550
|
+
commitSha: string;
|
|
551
|
+
refKind: CodeDiffRefKind;
|
|
552
|
+
versionSource?: CodeDiffVersionSource;
|
|
553
|
+
}
|
|
554
|
+
interface RawCodeDiffSummary {
|
|
555
|
+
filesChanged: number;
|
|
556
|
+
added: number;
|
|
557
|
+
deleted: number;
|
|
558
|
+
modified: number;
|
|
559
|
+
modeChanged: number;
|
|
560
|
+
typeChanged: number;
|
|
561
|
+
inventoryComplete: boolean;
|
|
562
|
+
unprojectableFiles: number;
|
|
563
|
+
}
|
|
564
|
+
interface RawCodeDiffScope {
|
|
565
|
+
/** Scope of returned paths and counts, independent of addressing form. */
|
|
566
|
+
status: RawCodeDiffScopeStatus;
|
|
567
|
+
/** Legacy package-scope metadata; absent from current repository results. */
|
|
568
|
+
fromSubpath?: string;
|
|
569
|
+
/** Legacy package-scope metadata; absent from current repository results. */
|
|
570
|
+
toSubpath?: string;
|
|
571
|
+
/** Caller-supplied repository-relative filter, not verified package scope. */
|
|
572
|
+
pathPrefix?: string;
|
|
573
|
+
/** Caller-supplied repository-relative filter, not verified package scope. */
|
|
574
|
+
pathGlob?: string;
|
|
575
|
+
}
|
|
576
|
+
interface RawCodeDiffContentFailure {
|
|
577
|
+
code: string;
|
|
578
|
+
retryable: boolean;
|
|
579
|
+
retryAfterMs?: number;
|
|
580
|
+
stage?: string;
|
|
581
|
+
limitKind?: string;
|
|
582
|
+
}
|
|
534
583
|
interface ContentSafety {
|
|
535
584
|
filtered: boolean;
|
|
536
585
|
modifications: ContentModification[];
|
|
537
586
|
}
|
|
587
|
+
interface RawCodeDiffFile {
|
|
588
|
+
path: string;
|
|
589
|
+
pathEncoding: RawCodeDiffPathEncoding;
|
|
590
|
+
status: RawCodeDiffFileStatus;
|
|
591
|
+
modeChanged: boolean;
|
|
592
|
+
typeChanged: boolean;
|
|
593
|
+
additions?: number;
|
|
594
|
+
deletions?: number;
|
|
595
|
+
patch?: string;
|
|
596
|
+
contentStatus: RawCodeDiffFileContentStatus;
|
|
597
|
+
contentOmissionReason?: string;
|
|
598
|
+
contentSafety: ContentSafety;
|
|
599
|
+
}
|
|
600
|
+
interface RawCodeDiff {
|
|
601
|
+
summary: RawCodeDiffSummary;
|
|
602
|
+
scope: RawCodeDiffScope;
|
|
603
|
+
contentCoverage: RawCodeDiffContentCoverage;
|
|
604
|
+
contentFailure?: RawCodeDiffContentFailure;
|
|
605
|
+
files: RawCodeDiffFile[];
|
|
606
|
+
hasMoreFiles: boolean;
|
|
607
|
+
}
|
|
608
|
+
interface CodeDiffResult {
|
|
609
|
+
package?: CodeDiffPackageInfo;
|
|
610
|
+
fromResolution: CodeDiffRefResolution;
|
|
611
|
+
toResolution: CodeDiffRefResolution;
|
|
612
|
+
raw: RawCodeDiff;
|
|
613
|
+
}
|
|
538
614
|
type GrepRepoPatternType = "LITERAL" | "REGEX";
|
|
539
615
|
type GrepPathSelectorKind = "EXACT" | "PREFIX" | "GLOB";
|
|
540
616
|
interface GrepRepoPathSelector {
|
|
@@ -614,6 +690,10 @@ interface CodeNavigationService {
|
|
|
614
690
|
readFile(params: ReadFileParams): Promise<ReadFileResult>;
|
|
615
691
|
grepRepo(params: GrepRepoParams): Promise<GrepRepoResult>;
|
|
616
692
|
}
|
|
693
|
+
/** Additive client capability for the unpromoted CodeDiff surface. */
|
|
694
|
+
interface CodeDiffService {
|
|
695
|
+
codeDiff(params: CodeDiffParams): Promise<CodeDiffResult>;
|
|
696
|
+
}
|
|
617
697
|
/**
|
|
618
698
|
* Parameters for search API call.
|
|
619
699
|
*/
|
|
@@ -776,7 +856,7 @@ interface ListParams {
|
|
|
776
856
|
}
|
|
777
857
|
type ListInventoryKind = "SOURCE" | "SITE";
|
|
778
858
|
type ListEntryKind = "FILE" | "PAGE" | "DIRECTORY";
|
|
779
|
-
type ListSiteWaitOutcome = "COMPLETED" | "DISCARDED" | "CANCELLED" | "TIMEOUT";
|
|
859
|
+
type ListSiteWaitOutcome = "COMPLETED" | "DISCARDED" | "CANCELLED" | "TIMEOUT" | "FAILED" | "SUPERSEDED";
|
|
780
860
|
interface ListReadAction {
|
|
781
861
|
target: string;
|
|
782
862
|
path: string | null;
|
|
@@ -1598,6 +1678,47 @@ type ReadResult = ReadCodeResult | ReadDocsResult | ReadSymbolResolutionResult;
|
|
|
1598
1678
|
interface ReadService {
|
|
1599
1679
|
read(params: ReadParams): Promise<ReadResult>;
|
|
1600
1680
|
}
|
|
1681
|
+
import { z as z2 } from "zod";
|
|
1682
|
+
/** Annotation fields required by OpenAI's MCP marketplace validation. */
|
|
1683
|
+
interface CompleteToolAnnotations {
|
|
1684
|
+
title?: string;
|
|
1685
|
+
readOnlyHint: boolean;
|
|
1686
|
+
idempotentHint?: boolean;
|
|
1687
|
+
openWorldHint: boolean;
|
|
1688
|
+
destructiveHint: boolean;
|
|
1689
|
+
}
|
|
1690
|
+
interface McpAuthActionContext {
|
|
1691
|
+
authSource: unknown;
|
|
1692
|
+
defaultAction: string;
|
|
1693
|
+
}
|
|
1694
|
+
type McpAuthAction = string | ((context: McpAuthActionContext) => string);
|
|
1695
|
+
/** Host-selected message and action for terms-acceptance failures. */
|
|
1696
|
+
interface ToolTermsRemediation {
|
|
1697
|
+
message: string;
|
|
1698
|
+
action: string;
|
|
1699
|
+
}
|
|
1700
|
+
/** Host-provided execution state shared by MCP and direct tool callers. */
|
|
1701
|
+
interface ToolExecutionContext {
|
|
1702
|
+
authAction?: McpAuthAction;
|
|
1703
|
+
termsRemediation?: ToolTermsRemediation;
|
|
1704
|
+
signal?: AbortSignal;
|
|
1705
|
+
}
|
|
1706
|
+
/**
|
|
1707
|
+
* Standard result type for all MCP tools
|
|
1708
|
+
*/
|
|
1709
|
+
type ToolResult = {
|
|
1710
|
+
content: Array<{
|
|
1711
|
+
type: "text";
|
|
1712
|
+
text: string;
|
|
1713
|
+
}>;
|
|
1714
|
+
isError?: boolean;
|
|
1715
|
+
};
|
|
1716
|
+
/**
|
|
1717
|
+
* Zod raw shape type (what MCP SDK expects)
|
|
1718
|
+
*/
|
|
1719
|
+
type ZodRawShape = {
|
|
1720
|
+
[k: string]: z2.ZodTypeAny;
|
|
1721
|
+
};
|
|
1601
1722
|
/**
|
|
1602
1723
|
* Services required to construct the MCP tool surface.
|
|
1603
1724
|
*
|
|
@@ -1606,7 +1727,7 @@ interface ReadService {
|
|
|
1606
1727
|
*/
|
|
1607
1728
|
interface McpToolServices {
|
|
1608
1729
|
githitsService: GitHitsService;
|
|
1609
|
-
codeNavigationService: CodeNavigationService;
|
|
1730
|
+
codeNavigationService: CodeNavigationService & CodeDiffService;
|
|
1610
1731
|
packageIntelligenceService: PackageIntelligenceService;
|
|
1611
1732
|
listService: ListService;
|
|
1612
1733
|
readService: ReadService;
|