Skip to content

feat(mcp): add $schema reference in README and sync schema in roll.js #1508

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
lennondotw wants to merge 1 commit into from
+24 −5
Closed

feat(mcp): add $schema reference in README and sync schema in roll.js #1508

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -486,6 +486,17 @@ using the `--config` command line option:
npx @playwright/mcp@latest --config path/to/config.json
```

Add `$schema` to your config file for IDE autocompletion and validation:

```json
{
"$schema": "https://raw.githubusercontent.com/microsoft/playwright/main/packages/playwright-core/src/tools/mcp/mcp-config.schema.json",
"browser": {
"browserName": "chromium"
}
}
```

<details>
<summary>Configuration file schema</summary>

Expand Down
18 changes: 13 additions & 5 deletions roll.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,23 @@ const path = require('path');
const { execSync } = require('child_process');

function copyConfig() {
const src = path.join(__dirname, '..', 'playwright', 'packages', 'playwright-core', 'src', 'tools', 'mcp', 'config.d.ts');
const dst = path.join(__dirname, 'packages', 'playwright-mcp', 'config.d.ts');
let content = fs.readFileSync(src, 'utf-8');
const mcpDir = path.join(__dirname, '..', 'playwright', 'packages', 'playwright-core', 'src', 'tools', 'mcp');
const dstDir = path.join(__dirname, 'packages', 'playwright-mcp');

const configSrc = path.join(mcpDir, 'config.d.ts');
let content = fs.readFileSync(configSrc, 'utf-8');
content = content.replace(
"import type * as playwright from 'playwright-core';",
"import type * as playwright from 'playwright';"
);
fs.writeFileSync(dst, content);
console.log(`Copied config.d.ts from ${src} to ${dst}`);
fs.writeFileSync(path.join(dstDir, 'config.d.ts'), content);
console.log(`Copied config.d.ts`);

const schemaSrc = path.join(mcpDir, 'mcp-config.schema.json');
if (fs.existsSync(schemaSrc)) {
fs.copyFileSync(schemaSrc, path.join(dstDir, 'mcp-config.schema.json'));
console.log(`Copied mcp-config.schema.json`);
}
}

function updatePlaywrightVersion(version) {
Expand Down