Warning

Experimental. This extension is experimental and not yet ready for production use. It is built on top of WebMCP, which is itself an experimental, early-stage proposal. Both the underlying specification and this extension's API may change or break at any time without notice. Use at your own risk.

Quickstart

This walkthrough takes you from a freshly installed extension to a working tool that an AI agent can call on the page. It uses the static primitive, so no JavaScript and no external index are required.

Prerequisites

The extension is installed and set up (see Installation).
You have a site package where you can add PHP classes and TypoScript.

Step 1 – Write a tool provider

Create a small PHP class in your site package (or any extension). Because the \Neoblack\Webmcp\Tool\ToolProviderInterface carries the #[AutoconfigureTag('webmcp.tool')] attribute, an autoconfigured service implementing it is picked up automatically — no Services.yaml entry is needed as long as your extension enables autoconfiguration.

EXT:my_sitepackage/Classes/Tool/ServicesToolProvider.php

<?php

declare(strict_types=1);

namespace Vendor\SitePackage\Tool;

use Neoblack\Webmcp\Tool\Manifest;
use Neoblack\Webmcp\Tool\Primitive;
use Neoblack\Webmcp\Tool\ToolProviderInterface;
use TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer;

final class ServicesToolProvider implements ToolProviderInterface
{
    public function name(): string
    {
        return 'list_services';
    }

    public function manifest(ContentObjectRenderer $cObj, array $processedData): ?Manifest
    {
        return new Manifest(
            name: 'list_services',
            description: 'List the services this company offers.',
            inputSchema: ['type' => 'object', 'properties' => new \stdClass()],
            primitive: Primitive::StaticList,
            data: [
                'items' => [
                    ['title' => 'Consulting', 'url' => 'https://example.org/consulting'],
                    ['title' => 'Development', 'url' => 'https://example.org/development'],
                ],
                'resultKey' => 'services',
                'text' => [
                    'heading' => 'Our services:',
                    'line' => '{n}. {title} – {url}',
                ],
            ],
        );
    }
}

Note

If your site package does not autoconfigure services, add the tag manually:

EXT:my_sitepackage/Configuration/Services.yaml

Vendor\SitePackage\Tool\ServicesToolProvider:
  tags:
    - name: webmcp.tool

Step 2 – Wire the manifest into the page

Add the three pieces described in Configuration to your site package. In short:

TypoScript setup — data processor and runtime

page.10.dataProcessing {
    40 = Neoblack\Webmcp\DataProcessing\ToolManifestProcessor
    40 {
        endpoint = /webmcp-event
        as = webmcpConfigJson
    }
}

page.includeJSFooter {
    webmcp = EXT:neoblack_webmcp/Resources/Public/JavaScript/webmcp.js
    webmcp.defer = 1
}

Render the JSON block once in your page template:

Fluid page template — emit the manifest

<f:if condition="{webmcpConfigJson}">
    <script type="application/json" id="webmcp-config"><f:format.raw>{webmcpConfigJson}</f:format.raw></script>
</f:if>

Step 3 – Verify it in the browser

Reload a frontend page and open the browser's developer console.

Confirm the manifest is on the page:

Console — inspect the manifest
```
JSON.parse(document.getElementById('webmcp-config').textContent).tools
```
Copied!
You should see your list_services tool in the returned array.

The parsed manifest in the browser console, listing the list_services tool.
Confirm the runtime registered it against the ModelContext:

Console — check for an agent surface
```
document.modelContext || navigator.modelContext
```
Copied!
A ModelContext implementation is only present in agent-capable browsers (for example Chrome with the WebMCP flag or origin trial, see Standards and browser support). If document.modelContext and navigator.modelContext are both undefined, the page is fine — there is simply no agent surface to register against. To list the tools the page actually registered, use the Model Context Tool Inspector extension (see Troubleshooting).

Tip

Once an agent operates the page, it can discover list_services and call it; the runtime returns the curated list and (unless disabled) records one anonymous usage row visible in the backend module.

Next steps

Swap static for another primitive — search, navigate or mailto — see Writing tools.
Return null from manifest() to hide a tool on pages where it does not apply.