gitcode-api 1.2.6__py3-none-any.whl → 1.2.8__py3-none-any.whl

gitcode_api/cli.py

@@ -1,7 +1,6 @@
 """Command-line interface for the GitCode SDK."""
 
 import argparse
-import asyncio
 import inspect
 import json
 import re

gitcode_api/llm/__init__.py

@@ -4,7 +4,13 @@ from importlib import import_module
 from typing import TYPE_CHECKING, Any, Dict
 
 if TYPE_CHECKING:
-    from .mcp import GitCodeMCP, create_mcp_gitcode_api_tool, create_mcp_server, register_mcp_gitcode_api_tool
+    from .mcp import (
+        GitCodeMCP,
+        create_mcp_gitcode_api_tool,
+        create_mcp_server,
+        register_mcp_gitcode_api_tool,
+        register_mcp_help_resources,
+    )
     from .openai import GitCodeOpenAITool
 
 
@@ -13,6 +19,7 @@ _IMPORT_MAP = {
     "create_mcp_gitcode_api_tool": ".mcp",
     "create_mcp_server": ".mcp",
     "register_mcp_gitcode_api_tool": ".mcp",
+    "register_mcp_help_resources": ".mcp",
     "GitCodeOpenAITool": ".openai",
 }
 
@@ -46,4 +53,5 @@ __all__ = [
     "create_mcp_gitcode_api_tool",
     "create_mcp_server",
     "register_mcp_gitcode_api_tool",
+    "register_mcp_help_resources",
 ]

gitcode_api/llm/_tool.py

@@ -3,9 +3,9 @@
 import base64
 import inspect
 import logging
+import os
 from collections.abc import Mapping
 from functools import lru_cache
-import os
 from typing import Any, Callable, Dict, Optional, Tuple
 
 from gitcode_api import (
@@ -26,9 +26,27 @@ OP_TYPES = frozenset(
     if inspect.isclass(annotation) and issubclass(annotation, SyncResource)
 )
 OP_TYPE_ENUM = sorted(OP_TYPES)
+
+MCP_SERVER_INSTRUCTIONS = (
+    "This MCP server exposes the GitCode REST API through the gitcode-api package.\n\n"
+    "Use the single tool gitcode_api_tool with:\n"
+    "- op_type (required): client resource groups (same attribute names as on GitCode).\n"
+    "- action: the method on that resource (for example get, list).\n"
+    "- params: keyword arguments for that method as a JSON object; omit or null means {}.\n"
+    "- help: when true, returns formatted help (available methods or a method signature) instead of "
+    "calling the API where applicable.\n\n"
+    "Successful results are JSON-serializable. Raw bytes from endpoints such as contents.get_raw are "
+    'returned as {"encoding": "base64", "data": "<ascii>"}.\n'
+    'Failures are objects with "error": true and a "message" string.\n\n'
+    "Valid op_type values for this client version:\n- " + "\n- ".join(OP_TYPE_ENUM) + "\n\n"
+    "Optional MCP resources (read without calling the tool):\n"
+    "- gitcode-api://help — markdown index of help URIs\n"
+    "- gitcode-api://help/{op_type} — plain-text method list for that client resource\n"
+)
+
 TOOL_NAME = "gitcode_api_tool"
 TOOL_DESCRIPTION = (
-    "Call the GitCode REST API through the gitcode-api SDK. Use op_type to choose a client resource group, "
+    "Call the GitCode REST API through the gitcode-api client. Use op_type to choose a client resource group, "
     "action as the resource method name, and params as the keyword arguments for that method. Set help=true to "
     "inspect available resource methods or a target method signature without sending an API request."
 )
@@ -38,7 +56,7 @@ TOOL_PARAMETERS = {
         "op_type": {
             "type": "string",
             "enum": OP_TYPE_ENUM,
-            "description": "SDK resource group matching client.<op_type>, such as repos, issues, or pulls.",
+            "description": "Resource group matching client.<op_type>, such as repos, issues, or pulls.",
         },
         "action": {
             "type": "string",
@@ -46,11 +64,11 @@ TOOL_PARAMETERS = {
         },
         "params": {
             "type": "object",
-            "description": "Keyword arguments passed to the SDK method. Omitted or null is treated as {}.",
+            "description": "Keyword arguments passed to the client method. Omitted or null is treated as {}.",
         },
         "help": {
             "type": "boolean",
-            "description": "When true, return dynamic SDK help instead of sending a request.",
+            "description": "When true, return dynamic client help instead of sending a request.",
             "default": False,
         },
     },
@@ -73,7 +91,7 @@ def error_dict(message: str, **extra: Any) -> Dict[str, Any]:
 
 
 def serialize(value: Any) -> Any:
-    """Convert SDK responses into JSON-serializable values for tool clients."""
+    """Convert client responses into JSON-serializable values for tool clients."""
     if value is None or isinstance(value, (bool, int, float, str)):
         return value
     if isinstance(value, bytes):
@@ -129,6 +147,44 @@ def _format_action_help(*, op_type: str, resource: Any, action: str) -> str:
     return _format_help(op_type=op_type, resource=None, header=header)
 
 
+def op_type_help_resource_body(op_type: str) -> str:
+    """Return plain-text method list for one ``op_type``.
+
+    Content matches :meth:`GitCodeLLMTool.__async_call__` with ``help=true`` and an empty ``action``.
+
+    :param op_type: Resource attribute name on :class:`~gitcode_api.GitCode`.
+    :returns: Help body for MCP ``gitcode-api://help/{op_type}`` resources.
+    """
+    if op_type not in OP_TYPES:
+        allowed = ", ".join(OP_TYPE_ENUM)
+        return f"Unknown op_type {op_type!r}. Allowed: {allowed}."
+    resource = resource_for_op_type(op_type)
+    header = "Specify non-empty action to invoke a method. Available methods:"
+    return _format_help(op_type=op_type, resource=resource, header=header)
+
+
+def help_resource_index_body() -> str:
+    """Return markdown listing ``gitcode-api://help/<op_type>`` URIs for MCP discovery.
+
+    :returns: Index body for MCP ``gitcode-api://help``.
+    """
+    lines = [
+        "# GitCode API — MCP help resources",
+        "",
+        "Read any URI below for the method list for that `op_type` on `gitcode_api_tool`.",
+        "",
+    ]
+    for name in OP_TYPE_ENUM:
+        lines.append(f"- gitcode-api://help/{name}")
+    lines.extend(
+        [
+            "",
+            "The same text is returned by `gitcode_api_tool` with `help: true` and an empty `action`.",
+        ]
+    )
+    return "\n".join(lines)
+
+
 def validate_call_kwargs(
     fn: Callable[..., Any], params: Optional[Dict[str, Any]]
 ) -> Tuple[Optional[Dict[str, Any]], Optional[str]]:
@@ -191,8 +247,6 @@ class GitCodeLLMTool:
         decrypt: Optional[Callable] = None,
     ) -> None:
         """Create a reusable tool with lazy sync and async clients."""
-        if not (api_key or os.getenv(DEFAULT_TOKEN_ENV)):
-            raise GitCodeConfigurationError("No API key provided. Pass api_key=... or set GITCODE_ACCESS_TOKEN.")
         self._client = client
         self._async_client = async_client
         self._client_kwargs = {
@@ -204,10 +258,15 @@ class GitCodeLLMTool:
             "decrypt": decrypt,
         }
 
+    def _require_api_key_for_clients(self) -> None:
+        if not (self._client_kwargs.get("api_key") or os.getenv(DEFAULT_TOKEN_ENV)):
+            raise GitCodeConfigurationError("No API key provided. Pass api_key=... or set GITCODE_ACCESS_TOKEN.")
+
     @property
     def client(self) -> GitCode:
         """Return the synchronous client, creating it lazily when needed."""
         if self._client is None:
+            self._require_api_key_for_clients()
             self._client = GitCode(**self._client_kwargs)  # type: ignore[arg-type]
         return self._client
 
@@ -215,6 +274,7 @@ class GitCodeLLMTool:
     def async_client(self) -> AsyncGitCode:
         """Return the asynchronous client, creating it lazily when needed."""
         if self._async_client is None:
+            self._require_api_key_for_clients()
             self._async_client = AsyncGitCode(**self._client_kwargs)  # type: ignore[arg-type]
         return self._async_client
 
@@ -226,7 +286,7 @@ class GitCodeLLMTool:
         help: bool = False,
         **kwargs,
     ) -> Any:
-        """Invoke a synchronous GitCode SDK method through the tool contract."""
+        """Invoke a synchronous GitCode client method through the tool contract."""
         if kwargs:
             return error_dict('Invalid tool invoke, API parameters should go into "params"')
         return self._invoke(op_type=op_type, action=action, params=params, help=help)
@@ -239,7 +299,7 @@ class GitCodeLLMTool:
         help: bool = False,
         **kwargs,
     ) -> Any:
-        """Invoke an asynchronous GitCode SDK method through the tool contract."""
+        """Invoke an asynchronous GitCode client method through the tool contract."""
         if kwargs:
             return error_dict('Invalid tool invoke, API parameters should go into "params"')
         return await self._ainvoke(op_type=op_type, action=action, params=params, help=help)

gitcode_api/llm/mcp.py

@@ -1,8 +1,15 @@
-"""FastMCP integration for the GitCode SDK LLM tool."""
+"""FastMCP integration for the GitCode LLM tool."""
 
 from typing import TYPE_CHECKING, Any, Callable, Optional, Union
 
-from ._tool import TOOL_DESCRIPTION, TOOL_NAME, GitCodeLLMTool
+from ._tool import (
+    MCP_SERVER_INSTRUCTIONS,
+    TOOL_DESCRIPTION,
+    TOOL_NAME,
+    GitCodeLLMTool,
+    help_resource_index_body,
+    op_type_help_resource_body,
+)
 
 if TYPE_CHECKING:
     from fastmcp import FastMCP
@@ -25,7 +32,7 @@ def _load_fastmcp() -> tuple["type[FastMCP]", Callable[..., "Tool"]]:
     return FastMCP, fastmcp_tool  # type: ignore[return-value]
 
 
-def create_mcp_gitcode_api_tool(tool: Optional[GitCodeLLMTool] = None) -> Any:
+def create_mcp_gitcode_api_tool(tool: Optional[GitCodeLLMTool] = None) -> Callable:
     """Return the async callable that can be registered with an MCP server.
 
     :param tool: Optional preconfigured shared GitCode LLM tool.
@@ -36,7 +43,7 @@ def create_mcp_gitcode_api_tool(tool: Optional[GitCodeLLMTool] = None) -> Any:
     async def gitcode_api_tool(
         op_type: str, action: str = "", params: Optional[dict[str, Any]] = None, help: bool = False
     ) -> Any:
-        """Call GitCode SDK resources using op_type, action, and params."""
+        """Call GitCode client resources using op_type, action, and params."""
         return await wrapped.__async_call__(op_type=op_type, action=action, params=params, help=help)
 
     gitcode_api_tool.__name__ = TOOL_NAME
@@ -44,7 +51,7 @@ def create_mcp_gitcode_api_tool(tool: Optional[GitCodeLLMTool] = None) -> Any:
     return gitcode_api_tool
 
 
-def register_mcp_gitcode_api_tool(mcp: Union["FastMCP", Any], tool: Optional[GitCodeLLMTool] = None) -> Any:
+def register_mcp_gitcode_api_tool(mcp: Union["FastMCP", Any], tool: Optional[GitCodeLLMTool] = None) -> "Tool":
     """Register the GitCode API tool with an existing FastMCP-compatible server.
 
     :param mcp: FastMCP server instance.
@@ -64,27 +71,74 @@ def register_mcp_gitcode_api_tool(mcp: Union["FastMCP", Any], tool: Optional[Git
     raise TypeError("mcp must provide a tool decorator or add_tool method")
 
 
+def register_mcp_help_resources(mcp: Union["FastMCP", Any]) -> None:
+    """Register optional MCP resources that mirror ``gitcode_api_tool`` help text.
+
+    Registers:
+
+    * ``gitcode-api://help`` — markdown index of per-``op_type`` URIs.
+    * ``gitcode-api://help/{op_type}`` — plain-text method list for one resource.
+
+    No-op when ``mcp`` does not expose FastMCP's ``resource`` decorator.
+
+    :param mcp: FastMCP server instance (or compatible object).
+    """
+    if not hasattr(mcp, "resource"):
+        return
+
+    @mcp.resource(
+        "gitcode-api://help/{op_type}",
+        name="gitcode_api_op_type_help",
+        description=("Method list for one op_type (same as gitcode_api_tool with help=true and empty action)."),
+        mime_type="text/plain",
+    )
+    async def _op_type_help_resource(op_type: str) -> str:
+        return op_type_help_resource_body(op_type)
+
+    @mcp.resource(
+        "gitcode-api://help",
+        name="gitcode_api_help_index",
+        description="Markdown index of gitcode-api://help/{op_type} help resources.",
+        mime_type="text/markdown",
+    )
+    async def _help_index_resource() -> str:
+        return help_resource_index_body()
+
+    _ = (_op_type_help_resource, _help_index_resource)
+
+
 class GitCodeMCP:
     """Small FastMCP server wrapper exposing the GitCode API tool.
 
     :param name: MCP server name.
     :param tool: Optional preconfigured shared GitCode LLM tool.
-    :param kwargs: Forwarded to ``fastmcp.FastMCP``.
+    :param kwargs: Forwarded to ``fastmcp.FastMCP``. If ``instructions`` is omitted, a default overview
+        of the tool (parameters, byte encoding, and valid ``op_type`` values) is supplied.
     """
 
-    def __init__(self, name: str = "GitCode API", tool: Optional[GitCodeLLMTool] = None, **kwargs) -> None:
+    def __init__(self, name: str = "GitCode API", tool: Optional[GitCodeLLMTool] = None, **kwargs: Any) -> None:
         """Create a FastMCP server and register the GitCode API tool."""
         fastmcp, *_ = _load_fastmcp()
+        if "instructions" not in kwargs:
+            kwargs["instructions"] = MCP_SERVER_INSTRUCTIONS
         self.mcp = fastmcp(name, **kwargs)
         self.gitcode_api_tool = register_mcp_gitcode_api_tool(self.mcp, tool)
+        register_mcp_help_resources(self.mcp)
 
     def __getattr__(self, name: str) -> Any:
         """Delegate unknown attributes to the wrapped FastMCP server."""
         return getattr(self.mcp, name)
 
 
-def create_mcp_server(name: str = "GitCode API", tool: Optional[GitCodeLLMTool] = None, **kwargs) -> "FastMCP":
-    """Create a FastMCP server with the GitCode API tool already registered."""
+def create_mcp_server(name: str = "GitCode API", tool: Optional[GitCodeLLMTool] = None, **kwargs: Any) -> "FastMCP":
+    """Create a FastMCP server with the GitCode API tool already registered.
+
+    :param name: MCP server display name.
+    :param tool: Optional preconfigured :class:`~gitcode_api.llm._tool.GitCodeLLMTool`.
+    :param kwargs: Forwarded to :class:`GitCodeMCP` and then to ``fastmcp.FastMCP`` (for example
+        ``instructions=`` to override the default server instructions).
+    :returns: Configured ``FastMCP`` instance with ``gitcode_api_tool`` registered.
+    """
     return GitCodeMCP(name=name, tool=tool, **kwargs).mcp
 
 
@@ -93,4 +147,5 @@ __all__ = [
     "create_mcp_gitcode_api_tool",
     "create_mcp_server",
     "register_mcp_gitcode_api_tool",
+    "register_mcp_help_resources",
 ]

gitcode_api/run_mcp.py

@@ -0,0 +1,6 @@
+"""Directly run GitCodeMCP."""
+
+from gitcode_api.llm.mcp import GitCodeMCP
+
+if __name__ == "__main__":
+    GitCodeMCP().mcp.run()

gitcode_api/version.txt

@@ -1 +1 @@
-1.2.6
+1.2.8

{gitcode_api-1.2.6.dist-info → gitcode_api-1.2.8.dist-info}/METADATA

@@ -1,13 +1,16 @@
 Metadata-Version: 2.4
 Name: gitcode-api
-Version: 1.2.6
+Version: 1.2.8
 Summary: Easy to use Python SDK for the GitCode REST API. Providing builtin CLI tool, and optional LLM integration (MCP and OpenAI tool) for agents. Community-maintained.
 Author-email: Hugo Huang <hugo@hugohuang.com>
 License-Expression: MIT
 Project-URL: changelog, https://gitcode-api.readthedocs.io/en/latest/changelog.html
+Project-URL: issues, https://github.com/Trenza1ore/GitCode-API/issues
 Project-URL: documentation, https://gitcode-api.readthedocs.io
 Project-URL: gitcode, https://gitcode.com/SushiNinja/GitCode-API
 Project-URL: github, https://github.com/Trenza1ore/GitCode-API
+Project-URL: homepage, https://linktr.ee/Hugoooo
+Project-URL: author, https://hugohuang.com
 Keywords: gitcode,git,devops,api,sdk,python,httpx,client,mcp,agent,fastmcp,llm,mcp client,mcp server,model context protocol
 Classifier: Development Status :: 4 - Beta
 Classifier: Programming Language :: Python
@@ -34,7 +37,8 @@ Dynamic: license-file
 
 # GitCode-API
 
-[![PyPI - Version](https://img.shields.io/pypi/v/gitcode-api?link=https%3A%2F%2Fpypi.org%2Fproject%2Fgitcode-api%2F)](https://pypi.org/project/gitcode-api) [![PyPI Downloads](https://static.pepy.tech/personalized-badge/gitcode-api?period=total&units=INTERNATIONAL_SYSTEM&left_color=GRAY&right_color=RED&left_text=downloads)](https://pepy.tech/projects/gitcode-api) [![CodeFactor](https://www.codefactor.io/repository/github/trenza1ore/gitcode-api/badge)](https://www.codefactor.io/repository/github/trenza1ore/gitcode-api) 
+[![PyPI - Version](https://img.shields.io/pypi/v/gitcode-api?link=https%3A%2F%2Fpypi.org%2Fproject%2Fgitcode-api%2F)](https://pypi.org/project/gitcode-api) [![PyPI Downloads](https://static.pepy.tech/personalized-badge/gitcode-api?period=total&units=INTERNATIONAL_SYSTEM&left_color=GRAY&right_color=RED&left_text=downloads)](https://pepy.tech/projects/gitcode-api) [![CodeFactor](https://www.codefactor.io/repository/github/trenza1ore/gitcode-api/badge)](https://www.codefactor.io/repository/github/trenza1ore/gitcode-api)
+[![Install in Cursor](https://img.shields.io/badge/Install_in-Cursor-000000?style=flat-square&logoColor=white)](https://cursor.com/en/install-mcp?name=GitCode%20API&config=eyJjb21tYW5kIjoidXZ4IiwiYXJncyI6WyItLWZyb20iLCJnaXRjb2RlLWFwaVttY3BdIiwiZ2l0Y29kZS1hcGkiLCJzZXJ2ZSJdLCJlbnYiOnsiR0lUQ09ERV9BQ0NFU1NfVE9LRU4iOiIke2lucHV0OmdpdGNvZGVfYWNjZXNzX3Rva2VufSJ9LCJpbnB1dHMiOlt7ImlkIjoiZ2l0Y29kZV9hY2Nlc3NfdG9rZW4iLCJ0eXBlIjoicHJvbXB0U3RyaW5nIiwiZGVzY3JpcHRpb24iOiJFbnRlciBHSVRDT0RFX0FDQ0VTU19UT0tFTiIsInBhc3N3b3JkIjp0cnVlfV19) [![Install in VS Code](https://img.shields.io/badge/Install_in-VS_Code-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://vscode.dev/redirect/mcp/install?name=GitCode%20API&config=%7B%22command%22%3A%22uvx%22%2C%22args%22%3A%5B%22--from%22%2C%22gitcode-api%5Bmcp%5D%22%2C%22gitcode-api%22%2C%22serve%22%5D%2C%22env%22%3A%7B%22GITCODE_ACCESS_TOKEN%22%3A%22%24%7Binput%3Agitcode_access_token%7D%22%7D%2C%22inputs%22%3A%5B%7B%22id%22%3A%22gitcode_access_token%22%2C%22type%22%3A%22promptString%22%2C%22description%22%3A%22Enter%20GITCODE_ACCESS_TOKEN%22%2C%22password%22%3Atrue%7D%5D%7D)
 [![GitHub Badge](https://img.shields.io/badge/github-repo-blue?logo=github&link=https%3A%2F%2Fgithub.com%2FTrenza1ore%2FGitCode-API)](https://github.com/Trenza1ore/GitCode-API) [![GitCode Badge](https://img.shields.io/badge/gitcode-repo-brown?logo=gitcode&link=https%3A%2F%2Fgitcode.com%2FSushiNinja%2FGitCode-API)](https://gitcode.com/SushiNinja/GitCode-API)
 
 [![Docs](https://img.shields.io/badge/%E6%96%87%E6%A1%A3-Docs-cyan?style=for-the-badge&logo=readthedocs&link=https%3A%2F%2Fgitcode-api.readthedocs.io%2Fen%2Flatest%2Findex.html)](https://gitcode-api.readthedocs.io) [![中文README](https://img.shields.io/badge/%E4%B8%AD%E6%96%87-README-brown?style=for-the-badge&logo=googledocs&link=README.zh.md)](README.zh.md)
@@ -48,6 +52,8 @@ Dynamic: license-file
 - Resource groups such as `client.repos`, `client.pulls`, and `client.users`.
 - Repository defaults via `owner=` and `repo=` on the client.
 - Sphinx docs plus a mirrored GitCode REST API reference in `docs/`.
+- Provides MCP server & OpenAI tool for LLM agent usage.
+- Provide MCP service that directly installs to your IDE of choice, such as Cursor and VS Code!
 
 ## Installation
 
@@ -57,6 +63,16 @@ Install from PyPI:
 pip install -U gitcode-api
 ```
 
+Install the MCP server to your AI-powered IDE of choice:
+[![Install in Cursor](https://img.shields.io/badge/Install_in-Cursor-000000?style=flat-square&logoColor=white)](https://cursor.com/en/install-mcp?name=GitCode%20API&config=eyJjb21tYW5kIjoidXZ4IiwiYXJncyI6WyItLWZyb20iLCJnaXRjb2RlLWFwaVttY3BdIiwiZ2l0Y29kZS1hcGkiLCJzZXJ2ZSJdLCJlbnYiOnsiR0lUQ09ERV9BQ0NFU1NfVE9LRU4iOiIke2lucHV0OmdpdGNvZGVfYWNjZXNzX3Rva2VufSJ9LCJpbnB1dHMiOlt7ImlkIjoiZ2l0Y29kZV9hY2Nlc3NfdG9rZW4iLCJ0eXBlIjoicHJvbXB0U3RyaW5nIiwiZGVzY3JpcHRpb24iOiJFbnRlciBHSVRDT0RFX0FDQ0VTU19UT0tFTiIsInBhc3N3b3JkIjp0cnVlfV19)
+[![Install in VS Code](https://img.shields.io/badge/Install_in-VS_Code-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://vscode.dev/redirect/mcp/install?name=GitCode%20API&config=%7B%22command%22%3A%22uvx%22%2C%22args%22%3A%5B%22--from%22%2C%22gitcode-api%5Bmcp%5D%22%2C%22gitcode-api%22%2C%22serve%22%5D%2C%22env%22%3A%7B%22GITCODE_ACCESS_TOKEN%22%3A%22%24%7Binput%3Agitcode_access_token%7D%22%7D%2C%22inputs%22%3A%5B%7B%22id%22%3A%22gitcode_access_token%22%2C%22type%22%3A%22promptString%22%2C%22description%22%3A%22Enter%20GITCODE_ACCESS_TOKEN%22%2C%22password%22%3Atrue%7D%5D%7D)
+[![Install in VS Code Insiders](https://img.shields.io/badge/Install_in-VS_Code_Insiders-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/redirect/mcp/install?name=GitCode%20API&config=%7B%22command%22%3A%22uvx%22%2C%22args%22%3A%5B%22--from%22%2C%22gitcode-api%5Bmcp%5D%22%2C%22gitcode-api%22%2C%22serve%22%5D%2C%22env%22%3A%7B%22GITCODE_ACCESS_TOKEN%22%3A%22%24%7Binput%3Agitcode_access_token%7D%22%7D%2C%22inputs%22%3A%5B%7B%22id%22%3A%22gitcode_access_token%22%2C%22type%22%3A%22promptString%22%2C%22description%22%3A%22Enter%20GITCODE_ACCESS_TOKEN%22%2C%22password%22%3Atrue%7D%5D%7D&quality=insiders)
+[![Install in Visual Studio](https://img.shields.io/badge/Install_in-Visual_Studio-C16FDE?style=flat-square&logo=visualstudio&logoColor=white)](https://vs-open.link/mcp-install?%7B%22command%22%3A%22uvx%22%2C%22args%22%3A%5B%22--from%22%2C%22gitcode-api%5Bmcp%5D%22%2C%22gitcode-api%22%2C%22serve%22%5D%2C%22env%22%3A%7B%22GITCODE_ACCESS_TOKEN%22%3A%22%24%7Binput%3Agitcode_access_token%7D%22%7D%2C%22inputs%22%3A%5B%7B%22id%22%3A%22gitcode_access_token%22%2C%22type%22%3A%22promptString%22%2C%22description%22%3A%22Enter%20GITCODE_ACCESS_TOKEN%22%2C%22password%22%3Atrue%7D%5D%7D)
+[![Install in Goose](https://block.github.io/goose/img/extension-install-dark.svg)](https://block.github.io/goose/extension?cmd=uvx&arg=--from%2520gitcode-api%5Bmcp%5D%2520gitcode-api%2520serve&id=GitCode%20API&name=GitCode%20API&description=MCP%20Server%20for%20GitCode%20API)
+[![Add MCP Server GitCode API to LM Studio](https://files.lmstudio.ai/deeplink/mcp-install-light.svg)](https://lmstudio.ai/install-mcp?name=GitCode%20API&config=eyJjb21tYW5kIjoidXZ4IiwiYXJncyI6WyItLWZyb20iLCJnaXRjb2RlLWFwaVttY3BdIiwiZ2l0Y29kZS1hcGkiLCJzZXJ2ZSJdLCJlbnYiOnsiR0lUQ09ERV9BQ0NFU1NfVE9LRU4iOiIke2lucHV0OmdpdGNvZGVfYWNjZXNzX3Rva2VufSJ9LCJpbnB1dHMiOlt7ImlkIjoiZ2l0Y29kZV9hY2Nlc3NfdG9rZW4iLCJ0eXBlIjoicHJvbXB0U3RyaW5nIiwiZGVzY3JpcHRpb24iOiJFbnRlciBHSVRDT0RFX0FDQ0VTU19UT0tFTiIsInBhc3N3b3JkIjp0cnVlfV19)
+
+For detailed setup (including installing to services like Claude Code / Codex): see [install_mcp_server.md](install_mcp_server.md).
+
 ## Authentication
 
 Pass `api_key=` directly, or set `GITCODE_ACCESS_TOKEN` in your environment:
@@ -299,6 +315,8 @@ The same server is available from the CLI as `gitcode-api serve` (see the [CLI](
 
 To share auth or clients across tools, build `GitCodeLLMTool` once (`from gitcode_api.llm._tool import GitCodeLLMTool`) and pass it as `tool=` into `GitCodeMCP`, `create_mcp_server`, `register_mcp_gitcode_api_tool`, or `create_mcp_gitcode_api_tool`.
 
+**Claude Desktop (MCPB):** published GitHub Releases include a `gitcode-<version>.mcpb` bundle for one-click installation as a Claude Desktop extension; see Anthropic’s guide, [Build a desktop extension with MCPB](https://claude.com/docs/connectors/building/mcpb). From a checkout you can run `make mcpb` (requires the [`@anthropic-ai/mcpb`](https://www.npmjs.com/package/@anthropic-ai/mcpb) CLI on your `PATH`).
+
 ## Examples
 
 Runnable examples live in `examples/`:

{gitcode_api-1.2.6.dist-info → gitcode_api-1.2.8.dist-info}/RECORD

@@ -6,12 +6,13 @@ gitcode_api/_cli_banner.py,sha256=3DsoJ2qZ-mWWB4yD-cnxDN_osXzrUKabrA5tbV6752M,97
 gitcode_api/_client.py,sha256=bmZxBHdfshM5Kv_EurHUVu8rsEj0k3Up3ATSIPaFrvc,8258
 gitcode_api/_exceptions.py,sha256=T5N8gBGmPSktDkLP5P_hxbzOHw3W378TzxN1xja40pA,1140
 gitcode_api/_models.py,sha256=v-GZzCGAb3_frY6wFiQww9m271U5MigivpEHDHnoDcI,109030
-gitcode_api/cli.py,sha256=DpnyGP54CkMGWwc8Krakt9i8RtAAsV45sN2UfgwMdIA,16631
+gitcode_api/cli.py,sha256=7LLDRCKJg7avaLgIwckZZC5LewSpMPWNQFFDRhAQkEs,16616
 gitcode_api/py.typed,sha256=mDShSrm8qg9qjacQc2F-rI8ATllqP6EdgHuEYxuCXZ0,7
-gitcode_api/version.txt,sha256=WET_zDRvicB7E7p1lr-zeI7XP0dV5UEYLXgi1Dt8eiQ,6
-gitcode_api/llm/__init__.py,sha256=YLILw5R8ViiaxGUXnlBAFAZQwo7YKAmNO1MOPEuesVI,1294
-gitcode_api/llm/_tool.py,sha256=4C9RbQh2tNJ1Y5V3eom1aOcC0sE4VMhbihHOZE-_c1k,13555
-gitcode_api/llm/mcp.py,sha256=J6r-COnJj9m1xbKw9u7h6DRgsi8slWkG5J6NhbERd3c,3615
+gitcode_api/run_mcp.py,sha256=a7zNrcAooGovzokJwTHQGj6iT4g7iltaUoD_E1KLvMg,130
+gitcode_api/version.txt,sha256=0tMVNGQdoBgBUSo-x5O8jVcTLUzvoZpftQPomV85648,6
+gitcode_api/llm/__init__.py,sha256=nCWs5jCnSxC9ILhiAh4vrNG0dVxkK3iqVz66c-0sE4I,1450
+gitcode_api/llm/_tool.py,sha256=mBQPYzQ-SuSWgumapcjv3pjGQfcPYt-IxUXBT5un2Lk,16239
+gitcode_api/llm/mcp.py,sha256=eeAuEETZ4THw31wbcnQaTlZQJ-9ZolvsejQY630OqHs,5702
 gitcode_api/llm/openai.py,sha256=CcS3tFntzAuN2HMbbQDctb54AnasU3n3a1Jr9LWAHwM,1998
 gitcode_api/resources/__init__.py,sha256=nsCKW0bFDZ5ombJZxLThmO82sOuF7o4OKUMRkAmwbwk,1725
 gitcode_api/resources/_shared.py,sha256=7bCym8bIfs818SiYYrBGI7-ZtiYlxECSDG3RduInu10,5387
@@ -19,9 +20,9 @@ gitcode_api/resources/account.py,sha256=mnc2p7wI-nBnHFNdWPNiHfmZpT6d3RDQC777gewt
 gitcode_api/resources/collaboration.py,sha256=8lyk78GTjVXddiE9fieutsMGovRjteGfTJcAhwLoR0M,101607
 gitcode_api/resources/misc.py,sha256=guDwh4cxbTVsSa7EivaYM3bKMJ8_Op4KucGbKEoayKE,22412
 gitcode_api/resources/repositories.py,sha256=EAK2znZhEsgVUu-NDEQslSEEYJzvb-kHuh4mW57y6sc,78178
-gitcode_api-1.2.6.dist-info/licenses/LICENSE,sha256=gOACXuWhMu6PJKVLr9RQbxX3HULnZIGNXCaMFJIXhoA,1067
-gitcode_api-1.2.6.dist-info/METADATA,sha256=YSRPn8DKQdeFM2fgGT0I9EFhr848na9Ph2zLZIlj920,15497
-gitcode_api-1.2.6.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
-gitcode_api-1.2.6.dist-info/entry_points.txt,sha256=dIPylJcgohIE2RRIlt3In2WzcwDK8TOdkL_ReKuij4o,53
-gitcode_api-1.2.6.dist-info/top_level.txt,sha256=gIlg0ptyOUHJT64ajOjWIhRPYgIQnMIvnhhnesw9fxU,12
-gitcode_api-1.2.6.dist-info/RECORD,,
+gitcode_api-1.2.8.dist-info/licenses/LICENSE,sha256=gOACXuWhMu6PJKVLr9RQbxX3HULnZIGNXCaMFJIXhoA,1067
+gitcode_api-1.2.8.dist-info/METADATA,sha256=xGX_RWA4_IiwVLLLGR1l58UVbiArZoocNxacHls7fU0,20698
+gitcode_api-1.2.8.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+gitcode_api-1.2.8.dist-info/entry_points.txt,sha256=dIPylJcgohIE2RRIlt3In2WzcwDK8TOdkL_ReKuij4o,53
+gitcode_api-1.2.8.dist-info/top_level.txt,sha256=gIlg0ptyOUHJT64ajOjWIhRPYgIQnMIvnhhnesw9fxU,12
+gitcode_api-1.2.8.dist-info/RECORD,,