ArchiveBox API

Instructions

Implementation Reference

• archivebox_api/archivebox_mcp.py:41-89 (handler)

  The primary MCP tool handler for 'get_api_token'. Decorated with @mcp.tool(), defines input schema via Pydantic Field descriptions, creates an ArchiveBox Api client instance, calls the client's get_api_token method to perform the actual API request, and returns the JSON response.

  @mcp.tool(
      exclude_args=[
          "archivebox_url",
          "username",
          "password",
          "token",
          "api_key",
          "verify",
      ],
      tags={"authentication"},
  )
  def get_api_token(
      username: Optional[str] = Field(
          description="The username for authentication",
      ),
      password: Optional[str] = Field(
          description="The password for authentication",
      ),
      archivebox_url: str = Field(
          default=os.environ.get("ARCHIVEBOX_URL", None),
          description="The URL of the ArchiveBox instance (e.g., https://yourinstance.archivebox.com)",
      ),
      token: Optional[str] = Field(
          default=os.environ.get("ARCHIVEBOX_TOKEN", None),
          description="Bearer token for authentication",
      ),
      api_key: Optional[str] = Field(
          default=os.environ.get("ARCHIVEBOX_API_KEY", None),
          description="API key for authentication",
      ),
      verify: Optional[bool] = Field(
          default=to_boolean(os.environ.get("ARCHIVEBOX_VERIFY", "True")),
          description="Whether to verify SSL certificates",
      ),
  ) -> dict:
      """
      Generate an API token for a given username & password.
      """
      client = Api(
          url=archivebox_url,
          username=username,
          password=password,
          token=token,
          api_key=api_key,
          verify=verify,
      )
      response = client.get_api_token(username=username, password=password)
      return response.json()

• archivebox_api/archivebox_api.py:83-114 (helper)

  Supporting helper method in the Api class that executes the HTTP POST request to the ArchiveBox server's /api/v1/auth/get_api_token endpoint with the provided username and password to obtain the API token.

  def get_api_token(
      self, username: Optional[str] = None, password: Optional[str] = None
  ) -> requests.Response:
      """
      Generate an API token for a given username & password
  
      Args:
          username: The username for authentication.
          password: The password for authentication.
  
      Returns:
          Response: The response object from the POST request.
  
      Raises:
          ParameterError: If the provided parameters are invalid.
      """
      try:
          data = {}
          if username is not None:
              data["username"] = username
          if password is not None:
              data["password"] = password
          response = self._session.post(
              url=f"{self.url}/api/v1/auth/get_api_token",
              json=data,
              headers={"Content-Type": "application/json"},
              verify=self.verify,
          )
      except ValidationError as e:
          raise ParameterError(f"Invalid parameters: {e.errors()}")
      return response

• archivebox_api/archivebox_mcp.py:24-37 (helper)

  Utility helper function used to convert the 'verify' parameter string from environment variable to boolean.

  def to_boolean(string: Union[str, bool] = None) -> bool:
      if isinstance(string, bool):
          return string
      if not string:
          return False
      normalized = str(string).strip().lower()
      true_values = {"t", "true", "y", "yes", "1"}
      false_values = {"f", "false", "n", "no", "0"}
      if normalized in true_values:
          return True
      elif normalized in false_values:
          return False
      else:
          raise ValueError(f"Cannot convert '{string}' to boolean")

• archivebox_api/archivebox_mcp.py:21-21 (registration)

  Initialization of the FastMCP server instance where tools like get_api_token are registered via decorators.

  mcp = FastMCP("ArchiveBox")