The_Great_Archive/ArchiveBox
1
0
Fork 0
mirror of https://github.com/ArchiveBox/ArchiveBox.git synced 2026-09-14 11:06:13 +05:00
Code Issues Actions Packages Projects Releases Wiki Activity
dev
ArchiveBox/docs/apidocs/archivebox/archivebox.mcp.server.md
Nick Sweeting f4932430db
Some checks are pending
CodeQL / Analyze (${{ matrix.language }}) (none, python) (push) Waiting to run
Details
Build Debian package / build (amd64) (push) Waiting to run
Details
Build Debian package / build (arm64) (push) Waiting to run
Details
Build Debian package / test (amd64, ubuntu-24.04) (push) Blocked by required conditions
Details
Build Debian package / test (arm64, ubuntu-24.04-arm) (push) Blocked by required conditions
Details
Build Debian package / release (push) Blocked by required conditions
Details
Build Docker image / build ${{ matrix.platform }} (digest-linux-amd64, docker-amd64, linux/amd64, ubuntu-24.04) (push) Waiting to run
Details
Build Docker image / build ${{ matrix.platform }} (digest-linux-arm64, docker-arm64, linux/arm64, ubuntu-24.04-arm) (push) Waiting to run
Details
Build Docker image / publish multiarch tags (push) Blocked by required conditions
Details
Run linters / lint (push) Waiting to run
Details
Build Pip package / build (push) Waiting to run
Details
Release State / release-state (push) Waiting to run
Details
Parallel Tests / Discover test files (push) Waiting to run
Details
Parallel Tests / ${{ matrix.test.name }} (push) Blocked by required conditions
Details
Parallel Tests / ${{ matrix.plugin.name }} (push) Blocked by required conditions
Details
Run tests / python_tests (ubuntu-22.04, 3.13) (push) Waiting to run
Details
Run tests / docker_tests (push) Waiting to run
Details
docs: regenerate sphinx apidocs to reflect current source tree 
Clean rebuild of docs/apidocs/archivebox/ via autodoc2:
- Removes 19 stale module pages whose source files no longer exist
  (cli_utils, host_utils, schedule_utils — renamed to *_util; actors,
  ideas, debugging, folders, legacy, progress_layout, tests_piping,
  config_tags, personas.runtime/views, orchestrator*, worker, tasks).
- Adds 29 new module pages for code that was added since the previous
  generation but not yet documented.
- Updates 100 existing pages to reflect API surface changes (e.g.
  ENABLED_PLUGINS Field removed, SNAPSHOTS_PER_PAGE clamp removed,
  default bumped to 50, etc.).

156 source modules <-> 156 apidoc files (zero drift). Build clean
under sphinx-build -W --keep-going.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-31 03:40:25 -07:00

4.1 KiB
Raw Permalink Blame History

{py:mod}archivebox.mcp.server

:allowtitles:

Module Contents

Classes

:class: autosummary longtable
:align: left

* - {py:obj}`MCPJSONEncoder <archivebox.mcp.server.MCPJSONEncoder>`
  - ```{autodoc2-docstring} archivebox.mcp.server.MCPJSONEncoder
    :summary:
    ```
* - {py:obj}`MCPServer <archivebox.mcp.server.MCPServer>`
  - ```{autodoc2-docstring} archivebox.mcp.server.MCPServer
    :summary:
    ```

Functions

:class: autosummary longtable
:align: left

* - {py:obj}`click_type_to_json_schema_type <archivebox.mcp.server.click_type_to_json_schema_type>`
  - ```{autodoc2-docstring} archivebox.mcp.server.click_type_to_json_schema_type
    :summary:
    ```
* - {py:obj}`click_command_to_mcp_tool <archivebox.mcp.server.click_command_to_mcp_tool>`
  - ```{autodoc2-docstring} archivebox.mcp.server.click_command_to_mcp_tool
    :summary:
    ```
* - {py:obj}`execute_click_command <archivebox.mcp.server.execute_click_command>`
  - ```{autodoc2-docstring} archivebox.mcp.server.execute_click_command
    :summary:
    ```
* - {py:obj}`run_mcp_server <archivebox.mcp.server.run_mcp_server>`
  - ```{autodoc2-docstring} archivebox.mcp.server.run_mcp_server
    :summary:
    ```

API

:canonical: archivebox.mcp.server.MCPJSONEncoder

Bases: {py:obj}`json.JSONEncoder`

```{autodoc2-docstring} archivebox.mcp.server.MCPJSONEncoder
```

```{rubric} Initialization
```

```{autodoc2-docstring} archivebox.mcp.server.MCPJSONEncoder.__init__
```

````{py:method} default(o)
:canonical: archivebox.mcp.server.MCPJSONEncoder.default

````


:canonical: archivebox.mcp.server.click_type_to_json_schema_type

```{autodoc2-docstring} archivebox.mcp.server.click_type_to_json_schema_type
```

:canonical: archivebox.mcp.server.click_command_to_mcp_tool

```{autodoc2-docstring} archivebox.mcp.server.click_command_to_mcp_tool
```

:canonical: archivebox.mcp.server.execute_click_command

```{autodoc2-docstring} archivebox.mcp.server.execute_click_command
```

:canonical: archivebox.mcp.server.MCPServer

```{autodoc2-docstring} archivebox.mcp.server.MCPServer
```

```{rubric} Initialization
```

```{autodoc2-docstring} archivebox.mcp.server.MCPServer.__init__
```

````{py:method} get_click_command(cmd_name: str) -> click.Command | None
:canonical: archivebox.mcp.server.MCPServer.get_click_command

```{autodoc2-docstring} archivebox.mcp.server.MCPServer.get_click_command
```

````

````{py:method} handle_initialize(params: dict) -> dict
:canonical: archivebox.mcp.server.MCPServer.handle_initialize

```{autodoc2-docstring} archivebox.mcp.server.MCPServer.handle_initialize
```

````

````{py:method} handle_tools_list(params: dict) -> dict
:canonical: archivebox.mcp.server.MCPServer.handle_tools_list

```{autodoc2-docstring} archivebox.mcp.server.MCPServer.handle_tools_list
```

````

````{py:method} handle_tools_call(params: dict) -> dict
:canonical: archivebox.mcp.server.MCPServer.handle_tools_call

```{autodoc2-docstring} archivebox.mcp.server.MCPServer.handle_tools_call
```

````

````{py:method} handle_request(request: dict) -> dict
:canonical: archivebox.mcp.server.MCPServer.handle_request

```{autodoc2-docstring} archivebox.mcp.server.MCPServer.handle_request
```

````

````{py:method} run_stdio_server()
:canonical: archivebox.mcp.server.MCPServer.run_stdio_server

```{autodoc2-docstring} archivebox.mcp.server.MCPServer.run_stdio_server
```

````


:canonical: archivebox.mcp.server.run_mcp_server

```{autodoc2-docstring} archivebox.mcp.server.run_mcp_server
```