@foundation0/git 1.3.1 → 1.3.2

package/mcp/README.md

@@ -12,11 +12,13 @@ Each tool is addressed by the full API path (`repo.issue.create`, `search.issues
 - `args`: array of positional string arguments
 - `options`: object for request body/query/header customisation
 
-Tool results are returned as a compact envelope by default:
-
-```json
-{ "ok": true, "data": { "...": "..." }, "meta": { "status": 200 } }
-```
+Tool results are returned as a compact envelope by default:
+
+```json
+{ "ok": true, "data": { "...": "..." }, "meta": { "status": 200 } }
+```
+
+The default mode now returns a trimmed response body (empty/noisy nested fields removed, common entities compacted). To get the original upstream body, pass `full: true`.
 
 If the upstream git API returns `{ ok: false }` or an HTTP status `>= 400`, the MCP tool call is marked as an error (`isError: true`) and a typed error envelope is returned:
 
@@ -24,7 +26,8 @@ If the upstream git API returns `{ ok: false }` or an HTTP status `>= 400`, the
 { "ok": false, "error": { "code": "HTTP_NOT_FOUND", "status": 404, "message": "HTTP 404", "retryable": false }, "meta": { "status": 404 } }
 ```
 
-To include the full debug payload (mapping/request/response headers), pass `format: "debug"` (either top-level or in `options`).
+To include the full debug payload (mapping/request/response headers), pass `format: "debug"` (either top-level or in `options`).
+To return unfiltered API response data, pass `full: true` (either top-level or in `options`).
 
 Use the `batch` tool to run multiple calls in one request. It is the preferred mode when you want to issue multiple MCP calls because it executes them in parallel and returns a combined response.
 
@@ -115,21 +118,33 @@ console.log(result.isError)
 console.log(result.text)
 ```
 
-`callByPath` converts positional args and options for convenience. `call` can also be used with the raw tool arguments object:
+`callByPath` converts positional args and options for convenience. `call` can also be used with the raw tool arguments object:
 
 ```ts
 await client.call('repo.issue.create', {
   options: {
     data: { title: 'Issue from MCP' },
   },
-})
-```
+})
+```
+
+`callByPath` also accepts an optional fourth `controls` argument (`format`, `fields`, `validateOnly`, `full`):
+
+```ts
+await client.callByPath('repo.pr.view', [525], {}, { full: true })
+```
 
 To return a debug payload for a specific call:
 
 ```ts
-await client.call('repo.issue.list', { format: 'debug' })
-```
+await client.call('repo.issue.list', { format: 'debug' })
+```
+
+To bypass compact mode and return the full upstream payload:
+
+```ts
+await client.call('repo.pr.view', { number: 525, full: true })
+```
 
 ## Using with MCP-compatible agents
 

package/mcp/src/client.ts

@@ -46,11 +46,15 @@ export interface GitMcpClientOptions {
   version?: string
 }
 
-export interface GitMcpCallArgs {
-  args?: unknown[]
-  options?: Record<string, unknown>
-  [key: string]: unknown
-}
+export interface GitMcpCallArgs {
+  args?: unknown[]
+  options?: Record<string, unknown>
+  format?: 'terse' | 'debug'
+  fields?: string[] | string
+  validateOnly?: boolean
+  full?: boolean
+  [key: string]: unknown
+}
 
 export type GitMcpCallResponse = {
   isError: boolean
@@ -132,15 +136,20 @@ export class GitMcpClient {
     }
   }
 
-  public async callByPath(
-    path: string,
-    methodArgs: unknown[] = [],
-    methodOptions: Record<string, unknown> = {},
-  ): Promise<GitMcpCallResponse> {
-    const args = { args: methodArgs.map((value) => String(value)), options: methodOptions }
-    return this.call(path, args)
-  }
-}
+  public async callByPath(
+    path: string,
+    methodArgs: unknown[] = [],
+    methodOptions: Record<string, unknown> = {},
+    controls: Pick<GitMcpCallArgs, 'format' | 'fields' | 'validateOnly' | 'full'> = {},
+  ): Promise<GitMcpCallResponse> {
+    const args = {
+      args: methodArgs.map((value) => String(value)),
+      options: methodOptions,
+      ...controls,
+    }
+    return this.call(path, args)
+  }
+}
 
 export const createGitMcpClient = (options: GitMcpClientOptions = {}): GitMcpClient => {
   return new GitMcpClient(options)