Compare commits
88 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
cd9819d0e8 | ||
|
|
542b74d2b4 | ||
|
|
15c299778a | ||
|
|
5e0ac89c28 | ||
|
|
9e176c409f | ||
|
|
44fa8026c9 | ||
|
|
d6414a6426 | ||
|
|
c8a520fc48 | ||
|
|
f531b2c9cb | ||
|
|
4b62f68979 | ||
|
|
5b497bcca8 | ||
|
|
00b9c54515 | ||
|
|
79111366a9 | ||
|
|
956b79a1ab | ||
|
|
b58ad48e0a | ||
|
|
41fba2bd71 | ||
|
|
cd2b589338 | ||
|
|
fbd62cd838 | ||
|
|
6aab683338 | ||
|
|
85c64bbe0f | ||
|
|
b213c187b0 | ||
|
|
412f6dc6fe | ||
|
|
4b1a6842b1 | ||
|
|
9cc61b4faf | ||
|
|
33b4c00923 | ||
|
|
f5ed83a4ca | ||
|
|
2f7467ba29 | ||
|
|
d47197f41f | ||
|
|
dba2fd054d | ||
|
|
075397e57e | ||
|
|
e8b471ec60 | ||
|
|
c806df7b13 | ||
|
|
a0b4ffbe15 | ||
|
|
0a6f1c4ea4 | ||
|
|
c784f93a65 | ||
|
|
10c340c0b3 | ||
|
|
850520321b | ||
|
|
b717a2a8ed | ||
|
|
ff9544db83 | ||
|
|
c85ee1a6ec | ||
|
|
0fcb25d118 | ||
|
|
f4df37ca71 | ||
|
|
64f65ccd10 | ||
|
|
3f7e2d1b45 | ||
|
|
e0cb424dea | ||
|
|
86e0020b4a | ||
|
|
009aa9275b | ||
|
|
c016643bf9 | ||
|
|
8cc557d677 | ||
|
|
15d382b940 | ||
|
|
e72701b21c | ||
|
|
8ee8445342 | ||
|
|
ac6e678135 | ||
|
|
b945ace746 | ||
|
|
b3dce4097e | ||
|
|
67ed859c2a | ||
|
|
7da5e7273c | ||
|
|
fe59d4b35f | ||
|
|
a03ec7ad56 | ||
|
|
ad14743235 | ||
|
|
a9ffccd40f | ||
|
|
b4e016a0b8 | ||
|
|
e17bf17dff | ||
|
|
7ee5c87a4b | ||
|
|
2817952d0d | ||
|
|
fb900a8827 | ||
|
|
29e532687c | ||
|
|
d149b89889 | ||
|
|
1caecd00c7 | ||
|
|
9657b58e17 | ||
|
|
8dfea1c67f | ||
|
|
a86b580797 | ||
|
|
927e570c18 | ||
|
|
24e68fa41d | ||
|
|
e50322731b | ||
|
|
711089d261 | ||
|
|
4a7be8de75 | ||
|
|
1523338246 | ||
|
|
08bd91d119 | ||
|
|
ef83729796 | ||
|
|
a70854c02f | ||
|
|
d42e0e12fc | ||
|
|
335315f158 | ||
|
|
c49dedb83f | ||
|
|
0bfcb05422 | ||
|
|
ca0820c55e | ||
|
|
45fee738bc | ||
|
|
dc3419023f |
24
.github/workflows/ci.yml
vendored
@@ -16,14 +16,12 @@ jobs:
|
|||||||
with:
|
with:
|
||||||
node-version: '20'
|
node-version: '20'
|
||||||
cache: 'npm'
|
cache: 'npm'
|
||||||
- name: Install dependencies
|
- run: npm ci
|
||||||
run: npm ci
|
- run: npm run lint
|
||||||
- name: Run ESLint
|
|
||||||
run: npm run lint
|
|
||||||
- name: Ensure no changes
|
- name: Ensure no changes
|
||||||
run: git diff --exit-code
|
run: git diff --exit-code
|
||||||
|
|
||||||
test:
|
test_mcp:
|
||||||
strategy:
|
strategy:
|
||||||
fail-fast: false
|
fail-fast: false
|
||||||
matrix:
|
matrix:
|
||||||
@@ -42,8 +40,9 @@ jobs:
|
|||||||
run: npx playwright install --with-deps
|
run: npx playwright install --with-deps
|
||||||
- name: Run tests
|
- name: Run tests
|
||||||
run: npm run test
|
run: npm run test
|
||||||
|
working-directory: ./packages/playwright-mcp
|
||||||
|
|
||||||
test_docker:
|
test_mcp_docker:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
@@ -71,14 +70,12 @@ jobs:
|
|||||||
# Used for the Docker tests to share the test-results folder with the container.
|
# Used for the Docker tests to share the test-results folder with the container.
|
||||||
umask 0000
|
umask 0000
|
||||||
npm run test -- --project=chromium-docker
|
npm run test -- --project=chromium-docker
|
||||||
|
working-directory: ./packages/playwright-mcp
|
||||||
env:
|
env:
|
||||||
MCP_IN_DOCKER: 1
|
MCP_IN_DOCKER: 1
|
||||||
|
|
||||||
test_extension:
|
test_extension:
|
||||||
runs-on: macos-latest
|
runs-on: macos-latest
|
||||||
defaults:
|
|
||||||
run:
|
|
||||||
working-directory: ./extension
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
- name: Use Node.js 20
|
- name: Use Node.js 20
|
||||||
@@ -88,19 +85,17 @@ jobs:
|
|||||||
cache: 'npm'
|
cache: 'npm'
|
||||||
- name: Install dependencies
|
- name: Install dependencies
|
||||||
run: npm ci
|
run: npm ci
|
||||||
|
- name: Playwright install
|
||||||
|
run: npx playwright install --with-deps
|
||||||
- name: Build extension
|
- name: Build extension
|
||||||
run: npm run build
|
run: npm run build
|
||||||
|
working-directory: ./packages/extension
|
||||||
- name: Upload artifact
|
- name: Upload artifact
|
||||||
uses: actions/upload-artifact@v4
|
uses: actions/upload-artifact@v4
|
||||||
with:
|
with:
|
||||||
name: extension
|
name: extension
|
||||||
path: ./extension/dist
|
path: ./extension/dist
|
||||||
retention-days: 7
|
retention-days: 7
|
||||||
- name: Install MCP server
|
|
||||||
run: |
|
|
||||||
cd ..
|
|
||||||
npm ci
|
|
||||||
npx playwright install chromium
|
|
||||||
- name: Run tests
|
- name: Run tests
|
||||||
run: |
|
run: |
|
||||||
if [[ "$(uname)" == "Linux" ]]; then
|
if [[ "$(uname)" == "Linux" ]]; then
|
||||||
@@ -109,3 +104,4 @@ jobs:
|
|||||||
npm run test
|
npm run test
|
||||||
fi
|
fi
|
||||||
shell: bash
|
shell: bash
|
||||||
|
working-directory: ./packages/extension
|
||||||
|
|||||||
47
.github/workflows/publish-canary.yml
vendored
@@ -1,47 +0,0 @@
|
|||||||
name: Publish Canary
|
|
||||||
on:
|
|
||||||
schedule:
|
|
||||||
- cron: '0 8 * * *'
|
|
||||||
workflow_dispatch:
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
publish-canary:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
permissions:
|
|
||||||
contents: read
|
|
||||||
id-token: write # Needed for npm provenance
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
- uses: actions/setup-node@v4
|
|
||||||
with:
|
|
||||||
node-version: 18
|
|
||||||
registry-url: https://registry.npmjs.org/
|
|
||||||
|
|
||||||
- name: Get current date
|
|
||||||
id: date
|
|
||||||
run: echo "date=$(date +'%Y-%m-%d')" >> $GITHUB_OUTPUT
|
|
||||||
|
|
||||||
- name: Get current version
|
|
||||||
id: version
|
|
||||||
run: echo "version=$(node -p "require('./package.json').version")" >> $GITHUB_OUTPUT
|
|
||||||
|
|
||||||
- name: Set canary version
|
|
||||||
id: canary-version
|
|
||||||
run: echo "version=${{ steps.version.outputs.version }}-alpha-${{ steps.date.outputs.date }}" >> $GITHUB_OUTPUT
|
|
||||||
|
|
||||||
- name: Update package.json version
|
|
||||||
run: |
|
|
||||||
npm version ${{ steps.canary-version.outputs.version }} --no-git-tag-version
|
|
||||||
|
|
||||||
- run: npm ci
|
|
||||||
- run: npx playwright install --with-deps
|
|
||||||
- run: npm run lint
|
|
||||||
- run: npm run ctest
|
|
||||||
|
|
||||||
- name: Publish to npm with next tag
|
|
||||||
run: npm publish --tag next --provenance
|
|
||||||
env:
|
|
||||||
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
|
|
||||||
|
|
||||||
- name: Reset package.json version
|
|
||||||
run: git checkout -- package.json
|
|
||||||
112
.github/workflows/publish.yml
vendored
@@ -1,35 +1,108 @@
|
|||||||
name: Publish
|
name: Publish
|
||||||
on:
|
on:
|
||||||
|
workflow_dispatch:
|
||||||
|
schedule:
|
||||||
|
- cron: '0 8 * * *'
|
||||||
release:
|
release:
|
||||||
types: [published]
|
types: [published]
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
publish-npm:
|
publish-mcp-canary-npm:
|
||||||
|
if: github.event.schedule || github.event_name == 'workflow_dispatch'
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
permissions:
|
permissions:
|
||||||
contents: read
|
contents: read
|
||||||
id-token: write # Needed for npm provenance
|
id-token: write # Required for OIDC npm publishing
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v5
|
||||||
- uses: actions/setup-node@v4
|
- uses: actions/setup-node@v5
|
||||||
with:
|
with:
|
||||||
node-version: 18
|
node-version: 20
|
||||||
registry-url: https://registry.npmjs.org/
|
registry-url: https://registry.npmjs.org/
|
||||||
|
# Ensure npm 11.5.1 or later is installed (for OIDC npm publishing)
|
||||||
|
- name: Update npm
|
||||||
|
run: npm install -g npm@latest
|
||||||
|
|
||||||
|
- name: Get current date
|
||||||
|
id: date
|
||||||
|
run: echo "date=$(date +'%Y-%m-%d')" >> $GITHUB_OUTPUT
|
||||||
|
|
||||||
|
- name: Get current version
|
||||||
|
id: version
|
||||||
|
run: echo "version=$(node -p "require('./package.json').version")" >> $GITHUB_OUTPUT
|
||||||
|
|
||||||
|
- name: Set canary version
|
||||||
|
id: canary-version
|
||||||
|
run: echo "version=${{ steps.version.outputs.version }}-alpha-${{ steps.date.outputs.date }}" >> $GITHUB_OUTPUT
|
||||||
|
|
||||||
|
- name: Update package.json version
|
||||||
|
run: |
|
||||||
|
npm version ${{ steps.canary-version.outputs.version }} --no-git-tag-version
|
||||||
|
working-directory: ./packages/playwright-mcp
|
||||||
|
|
||||||
- run: npm ci
|
- run: npm ci
|
||||||
- run: npx playwright install --with-deps
|
- run: npx playwright install --with-deps
|
||||||
- run: npm run lint
|
- run: npm run lint
|
||||||
- run: npm run ctest
|
- run: npm run ctest
|
||||||
- run: npm publish --provenance
|
working-directory: ./packages/playwright-mcp
|
||||||
env:
|
|
||||||
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
|
|
||||||
|
|
||||||
publish-docker:
|
- name: Publish to npm with next tag
|
||||||
|
run: npm publish --tag next
|
||||||
|
working-directory: ./packages/playwright-mcp
|
||||||
|
|
||||||
|
publish-mcp-release-npm:
|
||||||
|
if: github.event_name == 'release'
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
id-token: write # Required for OIDC npm publishing
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v5
|
||||||
|
- uses: actions/setup-node@v5
|
||||||
|
with:
|
||||||
|
node-version: 20
|
||||||
|
registry-url: https://registry.npmjs.org/
|
||||||
|
# Ensure npm 11.5.1 or later is installed (for OIDC npm publishing)
|
||||||
|
- name: Update npm
|
||||||
|
run: npm install -g npm@latest
|
||||||
|
- run: npm ci
|
||||||
|
- run: npx playwright install --with-deps
|
||||||
|
- run: npm run lint
|
||||||
|
- run: npm run ctest
|
||||||
|
working-directory: ./packages/playwright-mcp
|
||||||
|
- run: npm publish
|
||||||
|
working-directory: ./packages/playwright-mcp
|
||||||
|
|
||||||
|
publish-cli-release-npm:
|
||||||
|
if: github.event_name == 'release'
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
id-token: write # Required for OIDC npm publishing
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v5
|
||||||
|
- uses: actions/setup-node@v5
|
||||||
|
with:
|
||||||
|
node-version: 20
|
||||||
|
registry-url: https://registry.npmjs.org/
|
||||||
|
# Ensure npm 11.5.1 or later is installed (for OIDC npm publishing)
|
||||||
|
- name: Update npm
|
||||||
|
run: npm install -g npm@latest
|
||||||
|
- run: npm ci
|
||||||
|
- run: npx playwright install --with-deps
|
||||||
|
- run: npm run lint
|
||||||
|
- run: npm publish
|
||||||
|
working-directory: ./packages/playwright-cli
|
||||||
|
|
||||||
|
publish-mcp-release-docker:
|
||||||
|
if: github.event_name == 'release'
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
permissions:
|
permissions:
|
||||||
contents: read
|
contents: read
|
||||||
id-token: write # Needed for OIDC login to Azure
|
id-token: write # Needed for OIDC login to Azure
|
||||||
environment: allow-publishing-docker-to-acr
|
environment: allow-publishing-docker-to-acr
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v5
|
||||||
- name: Set up QEMU # Needed for multi-platform builds (e.g., arm64 on amd64 runner)
|
- name: Set up QEMU # Needed for multi-platform builds (e.g., arm64 on amd64 runner)
|
||||||
uses: docker/setup-qemu-action@v3
|
uses: docker/setup-qemu-action@v3
|
||||||
- name: Set up Docker Buildx # Needed for multi-platform builds
|
- name: Set up Docker Buildx # Needed for multi-platform builds
|
||||||
@@ -46,8 +119,7 @@ jobs:
|
|||||||
id: build-push
|
id: build-push
|
||||||
uses: docker/build-push-action@v6
|
uses: docker/build-push-action@v6
|
||||||
with:
|
with:
|
||||||
context: .
|
file: ./Dockerfile
|
||||||
file: ./Dockerfile # Adjust path if your Dockerfile is elsewhere
|
|
||||||
platforms: linux/amd64,linux/arm64
|
platforms: linux/amd64,linux/arm64
|
||||||
push: true
|
push: true
|
||||||
tags: |
|
tags: |
|
||||||
@@ -68,28 +140,28 @@ jobs:
|
|||||||
attach_eol_manifest $tag
|
attach_eol_manifest $tag
|
||||||
done
|
done
|
||||||
|
|
||||||
package-extension:
|
package-release-extension:
|
||||||
|
if: github.event_name == 'release'
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
permissions:
|
permissions:
|
||||||
contents: write # Needed to upload release assets
|
contents: write # Needed to upload release assets
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v5
|
||||||
- uses: actions/setup-node@v4
|
- uses: actions/setup-node@v5
|
||||||
with:
|
with:
|
||||||
node-version: 20
|
node-version: 20
|
||||||
cache: 'npm'
|
cache: 'npm'
|
||||||
- name: Install extension dependencies
|
- name: Install extension dependencies
|
||||||
working-directory: ./extension
|
|
||||||
run: npm ci
|
run: npm ci
|
||||||
- name: Build extension
|
- name: Build extension
|
||||||
working-directory: ./extension
|
working-directory: ./packages/extension
|
||||||
run: npm run build
|
run: npm run build
|
||||||
- name: Get extension version
|
- name: Get extension version
|
||||||
id: get-version
|
id: get-version
|
||||||
working-directory: ./extension
|
working-directory: ./packages/extension
|
||||||
run: echo "version=$(node -p "require('./package.json').version")" >> $GITHUB_OUTPUT
|
run: echo "version=$(node -p "require('./package.json').version")" >> $GITHUB_OUTPUT
|
||||||
- name: Package extension
|
- name: Package extension
|
||||||
working-directory: ./extension
|
working-directory: ./packages/extension
|
||||||
run: |
|
run: |
|
||||||
cd dist
|
cd dist
|
||||||
zip -r ../playwright-mcp-extension-${{ steps.get-version.outputs.version }}.zip .
|
zip -r ../playwright-mcp-extension-${{ steps.get-version.outputs.version }}.zip .
|
||||||
@@ -98,4 +170,4 @@ jobs:
|
|||||||
env:
|
env:
|
||||||
GITHUB_TOKEN: ${{ github.token }}
|
GITHUB_TOKEN: ${{ github.token }}
|
||||||
run: |
|
run: |
|
||||||
gh release upload ${{github.event.release.tag_name}} ./extension/playwright-mcp-extension-${{ steps.get-version.outputs.version }}.zip
|
gh release upload ${{github.event.release.tag_name}} ./packages/extension/playwright-mcp-extension-${{ steps.get-version.outputs.version }}.zip
|
||||||
|
|||||||
2
.gitignore
vendored
@@ -1,5 +1,3 @@
|
|||||||
lib/
|
|
||||||
dist/
|
|
||||||
node_modules/
|
node_modules/
|
||||||
test-results/
|
test-results/
|
||||||
playwright-report/
|
playwright-report/
|
||||||
|
|||||||
@@ -16,6 +16,7 @@ WORKDIR /app
|
|||||||
RUN --mount=type=cache,target=/root/.npm,sharing=locked,id=npm-cache \
|
RUN --mount=type=cache,target=/root/.npm,sharing=locked,id=npm-cache \
|
||||||
--mount=type=bind,source=package.json,target=package.json \
|
--mount=type=bind,source=package.json,target=package.json \
|
||||||
--mount=type=bind,source=package-lock.json,target=package-lock.json \
|
--mount=type=bind,source=package-lock.json,target=package-lock.json \
|
||||||
|
--mount=type=bind,source=packages/playwright-mcp/package.json,target=packages/playwright-mcp/package.json \
|
||||||
npm ci --omit=dev && \
|
npm ci --omit=dev && \
|
||||||
# Install system dependencies for playwright
|
# Install system dependencies for playwright
|
||||||
npx -y playwright-core install-deps chromium
|
npx -y playwright-core install-deps chromium
|
||||||
@@ -28,10 +29,11 @@ FROM base AS builder
|
|||||||
RUN --mount=type=cache,target=/root/.npm,sharing=locked,id=npm-cache \
|
RUN --mount=type=cache,target=/root/.npm,sharing=locked,id=npm-cache \
|
||||||
--mount=type=bind,source=package.json,target=package.json \
|
--mount=type=bind,source=package.json,target=package.json \
|
||||||
--mount=type=bind,source=package-lock.json,target=package-lock.json \
|
--mount=type=bind,source=package-lock.json,target=package-lock.json \
|
||||||
|
--mount=type=bind,source=packages/playwright-mcp/package.json,target=packages/playwright-mcp/package.json \
|
||||||
npm ci
|
npm ci
|
||||||
|
|
||||||
# Copy the rest of the app
|
# Copy the rest of the app
|
||||||
COPY *.json *.js *.ts .
|
COPY packages/playwright-mcp/*.json packages/playwright-mcp/*.js packages/playwright-mcp/*.ts .
|
||||||
|
|
||||||
# ------------------------------
|
# ------------------------------
|
||||||
# Browser
|
# Browser
|
||||||
@@ -59,7 +61,7 @@ RUN chown -R ${USERNAME}:${USERNAME} node_modules
|
|||||||
USER ${USERNAME}
|
USER ${USERNAME}
|
||||||
|
|
||||||
COPY --from=browser --chown=${USERNAME}:${USERNAME} ${PLAYWRIGHT_BROWSERS_PATH} ${PLAYWRIGHT_BROWSERS_PATH}
|
COPY --from=browser --chown=${USERNAME}:${USERNAME} ${PLAYWRIGHT_BROWSERS_PATH} ${PLAYWRIGHT_BROWSERS_PATH}
|
||||||
COPY --chown=${USERNAME}:${USERNAME} cli.js package.json ./
|
COPY --chown=${USERNAME}:${USERNAME} packages/playwright-mcp/cli.js packages/playwright-mcp/package.json ./
|
||||||
|
|
||||||
# Run in headless and only with chromium (other browsers need more dependencies not included in this image)
|
# Run in headless and only with chromium (other browsers need more dependencies not included in this image)
|
||||||
ENTRYPOINT ["node", "cli.js", "--headless", "--browser", "chromium", "--no-sandbox"]
|
ENTRYPOINT ["node", "cli.js", "--headless", "--browser", "chromium", "--no-sandbox"]
|
||||||
|
|||||||
3
LICENSE
@@ -186,8 +186,7 @@
|
|||||||
same "printed page" as the copyright notice for easier
|
same "printed page" as the copyright notice for easier
|
||||||
identification within third-party archives.
|
identification within third-party archives.
|
||||||
|
|
||||||
Portions Copyright (c) Microsoft Corporation.
|
Copyright (c) Microsoft Corporation.
|
||||||
Portions Copyright 2017 Google Inc.
|
|
||||||
|
|
||||||
Licensed under the Apache License, Version 2.0 (the "License");
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
you may not use this file except in compliance with the License.
|
you may not use this file except in compliance with the License.
|
||||||
|
|||||||
616
README.md
@@ -2,6 +2,14 @@
|
|||||||
|
|
||||||
A Model Context Protocol (MCP) server that provides browser automation capabilities using [Playwright](https://playwright.dev). This server enables LLMs to interact with web pages through structured accessibility snapshots, bypassing the need for screenshots or visually-tuned models.
|
A Model Context Protocol (MCP) server that provides browser automation capabilities using [Playwright](https://playwright.dev). This server enables LLMs to interact with web pages through structured accessibility snapshots, bypassing the need for screenshots or visually-tuned models.
|
||||||
|
|
||||||
|
### Playwright MCP vs Playwright CLI
|
||||||
|
|
||||||
|
This package provides MCP interface into Playwright. If you are using a **coding agent**, you might benefit from using the [CLI+SKILLS](https://github.com/microsoft/playwright-cli) instead.
|
||||||
|
|
||||||
|
- **CLI**: Modern **coding agents** increasingly favor CLI–based workflows exposed as SKILLs over MCP because CLI invocations are more token-efficient: they avoid loading large tool schemas and verbose accessibility trees into the model context, allowing agents to act through concise, purpose-built commands. This makes CLI + SKILLs better suited for high-throughput coding agents that must balance browser automation with large codebases, tests, and reasoning within limited context windows.<br>**Learn more about [Playwright CLI with SKILLS](https://github.com/microsoft/playwright-cli)**.
|
||||||
|
|
||||||
|
- **MCP**: MCP remains relevant for specialized agentic loops that benefit from persistent state, rich introspection, and iterative reasoning over page structure, such as exploratory automation, self-healing tests, or long-running autonomous workflows where maintaining continuous browser context outweighs token cost concerns.
|
||||||
|
|
||||||
### Key Features
|
### Key Features
|
||||||
|
|
||||||
- **Fast and lightweight**. Uses Playwright's accessibility tree, not pixel-based input.
|
- **Fast and lightweight**. Uses Playwright's accessibility tree, not pixel-based input.
|
||||||
@@ -38,6 +46,31 @@ First, install the Playwright MCP server with your client.
|
|||||||
|
|
||||||
[<img src="https://img.shields.io/badge/VS_Code-VS_Code?style=flat-square&label=Install%20Server&color=0098FF" alt="Install in VS Code">](https://insiders.vscode.dev/redirect?url=vscode%3Amcp%2Finstall%3F%257B%2522name%2522%253A%2522playwright%2522%252C%2522command%2522%253A%2522npx%2522%252C%2522args%2522%253A%255B%2522%2540playwright%252Fmcp%2540latest%2522%255D%257D) [<img alt="Install in VS Code Insiders" src="https://img.shields.io/badge/VS_Code_Insiders-VS_Code_Insiders?style=flat-square&label=Install%20Server&color=24bfa5">](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Amcp%2Finstall%3F%257B%2522name%2522%253A%2522playwright%2522%252C%2522command%2522%253A%2522npx%2522%252C%2522args%2522%253A%255B%2522%2540playwright%252Fmcp%2540latest%2522%255D%257D)
|
[<img src="https://img.shields.io/badge/VS_Code-VS_Code?style=flat-square&label=Install%20Server&color=0098FF" alt="Install in VS Code">](https://insiders.vscode.dev/redirect?url=vscode%3Amcp%2Finstall%3F%257B%2522name%2522%253A%2522playwright%2522%252C%2522command%2522%253A%2522npx%2522%252C%2522args%2522%253A%255B%2522%2540playwright%252Fmcp%2540latest%2522%255D%257D) [<img alt="Install in VS Code Insiders" src="https://img.shields.io/badge/VS_Code_Insiders-VS_Code_Insiders?style=flat-square&label=Install%20Server&color=24bfa5">](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Amcp%2Finstall%3F%257B%2522name%2522%253A%2522playwright%2522%252C%2522command%2522%253A%2522npx%2522%252C%2522args%2522%253A%255B%2522%2540playwright%252Fmcp%2540latest%2522%255D%257D)
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>Amp</summary>
|
||||||
|
|
||||||
|
Add via the Amp VS Code extension settings screen or by updating your settings.json file:
|
||||||
|
|
||||||
|
```json
|
||||||
|
"amp.mcpServers": {
|
||||||
|
"playwright": {
|
||||||
|
"command": "npx",
|
||||||
|
"args": [
|
||||||
|
"@playwright/mcp@latest"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**Amp CLI Setup:**
|
||||||
|
|
||||||
|
Add via the `amp mcp add`command below
|
||||||
|
|
||||||
|
```bash
|
||||||
|
amp mcp add playwright -- npx @playwright/mcp@latest
|
||||||
|
```
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
<summary>Claude Code</summary>
|
<summary>Claude Code</summary>
|
||||||
@@ -56,10 +89,44 @@ Follow the MCP install [guide](https://modelcontextprotocol.io/quickstart/user),
|
|||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>Cline</summary>
|
||||||
|
|
||||||
|
Follow the instruction in the section [Configuring MCP Servers](https://docs.cline.bot/mcp/configuring-mcp-servers)
|
||||||
|
|
||||||
|
**Example: Local Setup**
|
||||||
|
|
||||||
|
Add the following to your [`cline_mcp_settings.json`](https://docs.cline.bot/mcp/configuring-mcp-servers#editing-mcp-settings-files) file:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"mcpServers": {
|
||||||
|
"playwright": {
|
||||||
|
"type": "stdio",
|
||||||
|
"command": "npx",
|
||||||
|
"timeout": 30,
|
||||||
|
"args": [
|
||||||
|
"-y",
|
||||||
|
"@playwright/mcp@latest"
|
||||||
|
],
|
||||||
|
"disabled": false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
<summary>Codex</summary>
|
<summary>Codex</summary>
|
||||||
|
|
||||||
Create or edit the configuration file `~/.codex/config.toml` and add:
|
Use the Codex CLI to add the Playwright MCP server:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
codex mcp add playwright npx "@playwright/mcp@latest"
|
||||||
|
```
|
||||||
|
|
||||||
|
Alternatively, create or edit the configuration file `~/.codex/config.toml` and add:
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
[mcp_servers.playwright]
|
[mcp_servers.playwright]
|
||||||
@@ -71,12 +138,44 @@ For more information, see the [Codex MCP documentation](https://github.com/opena
|
|||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>Copilot</summary>
|
||||||
|
|
||||||
|
Use the Copilot CLI to interactively add the Playwright MCP server:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
/mcp add
|
||||||
|
```
|
||||||
|
|
||||||
|
Alternatively, create or edit the configuration file `~/.copilot/mcp-config.json` and add:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"mcpServers": {
|
||||||
|
"playwright": {
|
||||||
|
"type": "local",
|
||||||
|
"command": "npx",
|
||||||
|
"tools": [
|
||||||
|
"*"
|
||||||
|
],
|
||||||
|
"args": [
|
||||||
|
"@playwright/mcp@latest"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
For more information, see the [Copilot CLI documentation](https://docs.github.com/en/copilot/concepts/agents/about-copilot-cli).
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
<summary>Cursor</summary>
|
<summary>Cursor</summary>
|
||||||
|
|
||||||
#### Click the button to install:
|
#### Click the button to install:
|
||||||
|
|
||||||
[<img src="https://cursor.com/deeplink/mcp-install-dark.svg" alt="Install in Cursor">](cursor://anysphere.cursor-deeplink/mcp/install?name=Playwright&config=eyJjb21tYW5kIjoibnB4IEBwbGF5d3JpZ2h0L21jcEBsYXRlc3QifQ%3D%3D)
|
[<img src="https://cursor.com/deeplink/mcp-install-dark.svg" alt="Install in Cursor">](https://cursor.com/en/install-mcp?name=Playwright&config=eyJjb21tYW5kIjoibnB4IEBwbGF5d3JpZ2h0L21jcEBsYXRlc3QifQ%3D%3D)
|
||||||
|
|
||||||
#### Or install manually:
|
#### Or install manually:
|
||||||
|
|
||||||
@@ -84,6 +183,21 @@ Go to `Cursor Settings` -> `MCP` -> `Add new MCP Server`. Name to your liking, u
|
|||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>Factory</summary>
|
||||||
|
|
||||||
|
Use the Factory CLI to add the Playwright MCP server:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
droid mcp add playwright "npx @playwright/mcp@latest"
|
||||||
|
```
|
||||||
|
|
||||||
|
Alternatively, type `/mcp` within Factory droid to open an interactive UI for managing MCP servers.
|
||||||
|
|
||||||
|
For more information, see the [Factory MCP documentation](https://docs.factory.ai/cli/configuration/mcp).
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
<summary>Gemini CLI</summary>
|
<summary>Gemini CLI</summary>
|
||||||
|
|
||||||
@@ -103,6 +217,25 @@ Follow the MCP install [guide](https://github.com/google-gemini/gemini-cli/blob/
|
|||||||
Go to `Advanced settings` -> `Extensions` -> `Add custom extension`. Name to your liking, use type `STDIO`, and set the `command` to `npx @playwright/mcp`. Click "Add Extension".
|
Go to `Advanced settings` -> `Extensions` -> `Add custom extension`. Name to your liking, use type `STDIO`, and set the `command` to `npx @playwright/mcp`. Click "Add Extension".
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>Kiro</summary>
|
||||||
|
|
||||||
|
Follow the MCP Servers [documentation](https://kiro.dev/docs/mcp/). For example in `.kiro/settings/mcp.json`:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"mcpServers": {
|
||||||
|
"playwright": {
|
||||||
|
"command": "npx",
|
||||||
|
"args": [
|
||||||
|
"@playwright/mcp@latest"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
</details>
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
<summary>LM Studio</summary>
|
<summary>LM Studio</summary>
|
||||||
|
|
||||||
@@ -165,6 +298,27 @@ code --add-mcp '{"name":"playwright","command":"npx","args":["@playwright/mcp@la
|
|||||||
After installation, the Playwright MCP server will be available for use with your GitHub Copilot agent in VS Code.
|
After installation, the Playwright MCP server will be available for use with your GitHub Copilot agent in VS Code.
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>Warp</summary>
|
||||||
|
|
||||||
|
Go to `Settings` -> `AI` -> `Manage MCP Servers` -> `+ Add` to [add an MCP Server](https://docs.warp.dev/knowledge-and-collaboration/mcp#adding-an-mcp-server). Use the standard config above.
|
||||||
|
|
||||||
|
Alternatively, use the slash command `/add-mcp` in the Warp prompt and paste the standard config from above:
|
||||||
|
```js
|
||||||
|
{
|
||||||
|
"mcpServers": {
|
||||||
|
"playwright": {
|
||||||
|
"command": "npx",
|
||||||
|
"args": [
|
||||||
|
"@playwright/mcp@latest"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
<summary>Windsurf</summary>
|
<summary>Windsurf</summary>
|
||||||
|
|
||||||
@@ -178,68 +332,50 @@ Playwright MCP server supports following arguments. They can be provided in the
|
|||||||
|
|
||||||
<!--- Options generated by update-readme.js -->
|
<!--- Options generated by update-readme.js -->
|
||||||
|
|
||||||
```
|
| Option | Description |
|
||||||
> npx @playwright/mcp@latest --help
|
|--------|-------------|
|
||||||
--allowed-origins <origins> semicolon-separated list of origins to allow
|
| --allowed-hosts <hosts...> | comma-separated list of hosts this server is allowed to serve from. Defaults to the host the server is bound to. Pass '*' to disable the host check.<br>*env* `PLAYWRIGHT_MCP_ALLOWED_HOSTS` |
|
||||||
the browser to request. Default is to allow
|
| --allowed-origins <origins> | semicolon-separated list of TRUSTED origins to allow the browser to request. Default is to allow all. Important: *does not* serve as a security boundary and *does not* affect redirects.<br>*env* `PLAYWRIGHT_MCP_ALLOWED_ORIGINS` |
|
||||||
all.
|
| --allow-unrestricted-file-access | allow access to files outside of the workspace roots. Also allows unrestricted access to file:// URLs. By default access to file system is restricted to workspace root directories (or cwd if no roots are configured) only, and navigation to file:// URLs is blocked.<br>*env* `PLAYWRIGHT_MCP_ALLOW_UNRESTRICTED_FILE_ACCESS` |
|
||||||
--blocked-origins <origins> semicolon-separated list of origins to block
|
| --blocked-origins <origins> | semicolon-separated list of origins to block the browser from requesting. Blocklist is evaluated before allowlist. If used without the allowlist, requests not matching the blocklist are still allowed. Important: *does not* serve as a security boundary and *does not* affect redirects.<br>*env* `PLAYWRIGHT_MCP_BLOCKED_ORIGINS` |
|
||||||
the browser from requesting. Blocklist is
|
| --block-service-workers | block service workers<br>*env* `PLAYWRIGHT_MCP_BLOCK_SERVICE_WORKERS` |
|
||||||
evaluated before allowlist. If used without
|
| --browser <browser> | browser or chrome channel to use, possible values: chrome, firefox, webkit, msedge.<br>*env* `PLAYWRIGHT_MCP_BROWSER` |
|
||||||
the allowlist, requests not matching the
|
| --caps <caps> | comma-separated list of additional capabilities to enable, possible values: vision, pdf.<br>*env* `PLAYWRIGHT_MCP_CAPS` |
|
||||||
blocklist are still allowed.
|
| --cdp-endpoint <endpoint> | CDP endpoint to connect to.<br>*env* `PLAYWRIGHT_MCP_CDP_ENDPOINT` |
|
||||||
--block-service-workers block service workers
|
| --cdp-header <headers...> | CDP headers to send with the connect request, multiple can be specified.<br>*env* `PLAYWRIGHT_MCP_CDP_HEADER` |
|
||||||
--browser <browser> browser or chrome channel to use, possible
|
| --codegen <lang> | specify the language to use for code generation, possible values: "typescript", "none". Default is "typescript".<br>*env* `PLAYWRIGHT_MCP_CODEGEN` |
|
||||||
values: chrome, firefox, webkit, msedge.
|
| --config <path> | path to the configuration file.<br>*env* `PLAYWRIGHT_MCP_CONFIG` |
|
||||||
--caps <caps> comma-separated list of additional
|
| --console-level <level> | level of console messages to return: "error", "warning", "info", "debug". Each level includes the messages of more severe levels.<br>*env* `PLAYWRIGHT_MCP_CONSOLE_LEVEL` |
|
||||||
capabilities to enable, possible values:
|
| --device <device> | device to emulate, for example: "iPhone 15"<br>*env* `PLAYWRIGHT_MCP_DEVICE` |
|
||||||
vision, pdf.
|
| --executable-path <path> | path to the browser executable.<br>*env* `PLAYWRIGHT_MCP_EXECUTABLE_PATH` |
|
||||||
--cdp-endpoint <endpoint> CDP endpoint to connect to.
|
| --extension | Connect to a running browser instance (Edge/Chrome only). Requires the "Playwright MCP Bridge" browser extension to be installed.<br>*env* `PLAYWRIGHT_MCP_EXTENSION` |
|
||||||
--cdp-header <headers...> CDP headers to send with the connect request,
|
| --grant-permissions <permissions...> | List of permissions to grant to the browser context, for example "geolocation", "clipboard-read", "clipboard-write".<br>*env* `PLAYWRIGHT_MCP_GRANT_PERMISSIONS` |
|
||||||
multiple can be specified.
|
| --headless | run browser in headless mode, headed by default<br>*env* `PLAYWRIGHT_MCP_HEADLESS` |
|
||||||
--config <path> path to the configuration file.
|
| --host <host> | host to bind server to. Default is localhost. Use 0.0.0.0 to bind to all interfaces.<br>*env* `PLAYWRIGHT_MCP_HOST` |
|
||||||
--device <device> device to emulate, for example: "iPhone 15"
|
| --ignore-https-errors | ignore https errors<br>*env* `PLAYWRIGHT_MCP_IGNORE_HTTPS_ERRORS` |
|
||||||
--executable-path <path> path to the browser executable.
|
| --init-page <path...> | path to TypeScript file to evaluate on Playwright page object<br>*env* `PLAYWRIGHT_MCP_INIT_PAGE` |
|
||||||
--extension Connect to a running browser instance
|
| --init-script <path...> | path to JavaScript file to add as an initialization script. The script will be evaluated in every page before any of the page's scripts. Can be specified multiple times.<br>*env* `PLAYWRIGHT_MCP_INIT_SCRIPT` |
|
||||||
(Edge/Chrome only). Requires the "Playwright
|
| --isolated | keep the browser profile in memory, do not save it to disk.<br>*env* `PLAYWRIGHT_MCP_ISOLATED` |
|
||||||
MCP Bridge" browser extension to be installed.
|
| --image-responses <mode> | whether to send image responses to the client. Can be "allow" or "omit", Defaults to "allow".<br>*env* `PLAYWRIGHT_MCP_IMAGE_RESPONSES` |
|
||||||
--headless run browser in headless mode, headed by
|
| --no-sandbox | disable the sandbox for all process types that are normally sandboxed.<br>*env* `PLAYWRIGHT_MCP_NO_SANDBOX` |
|
||||||
default
|
| --output-dir <path> | path to the directory for output files.<br>*env* `PLAYWRIGHT_MCP_OUTPUT_DIR` |
|
||||||
--host <host> host to bind server to. Default is localhost.
|
| --output-mode <mode> | whether to save snapshots, console messages, network logs to a file or to the standard output. Can be "file" or "stdout". Default is "stdout".<br>*env* `PLAYWRIGHT_MCP_OUTPUT_MODE` |
|
||||||
Use 0.0.0.0 to bind to all interfaces.
|
| --port <port> | port to listen on for SSE transport.<br>*env* `PLAYWRIGHT_MCP_PORT` |
|
||||||
--ignore-https-errors ignore https errors
|
| --proxy-bypass <bypass> | comma-separated domains to bypass proxy, for example ".com,chromium.org,.domain.com"<br>*env* `PLAYWRIGHT_MCP_PROXY_BYPASS` |
|
||||||
--isolated keep the browser profile in memory, do not
|
| --proxy-server <proxy> | specify proxy server, for example "http://myproxy:3128" or "socks5://myproxy:8080"<br>*env* `PLAYWRIGHT_MCP_PROXY_SERVER` |
|
||||||
save it to disk.
|
| --save-session | Whether to save the Playwright MCP session into the output directory.<br>*env* `PLAYWRIGHT_MCP_SAVE_SESSION` |
|
||||||
--image-responses <mode> whether to send image responses to the client.
|
| --save-trace | Whether to save the Playwright Trace of the session into the output directory.<br>*env* `PLAYWRIGHT_MCP_SAVE_TRACE` |
|
||||||
Can be "allow" or "omit", Defaults to "allow".
|
| --save-video <size> | Whether to save the video of the session into the output directory. For example "--save-video=800x600"<br>*env* `PLAYWRIGHT_MCP_SAVE_VIDEO` |
|
||||||
--no-sandbox disable the sandbox for all process types that
|
| --secrets <path> | path to a file containing secrets in the dotenv format<br>*env* `PLAYWRIGHT_MCP_SECRETS` |
|
||||||
are normally sandboxed.
|
| --shared-browser-context | reuse the same browser context between all connected HTTP clients.<br>*env* `PLAYWRIGHT_MCP_SHARED_BROWSER_CONTEXT` |
|
||||||
--output-dir <path> path to the directory for output files.
|
| --snapshot-mode <mode> | when taking snapshots for responses, specifies the mode to use. Can be "incremental", "full", or "none". Default is incremental.<br>*env* `PLAYWRIGHT_MCP_SNAPSHOT_MODE` |
|
||||||
--port <port> port to listen on for SSE transport.
|
| --storage-state <path> | path to the storage state file for isolated sessions.<br>*env* `PLAYWRIGHT_MCP_STORAGE_STATE` |
|
||||||
--proxy-bypass <bypass> comma-separated domains to bypass proxy, for
|
| --test-id-attribute <attribute> | specify the attribute to use for test ids, defaults to "data-testid"<br>*env* `PLAYWRIGHT_MCP_TEST_ID_ATTRIBUTE` |
|
||||||
example ".com,chromium.org,.domain.com"
|
| --timeout-action <timeout> | specify action timeout in milliseconds, defaults to 5000ms<br>*env* `PLAYWRIGHT_MCP_TIMEOUT_ACTION` |
|
||||||
--proxy-server <proxy> specify proxy server, for example
|
| --timeout-navigation <timeout> | specify navigation timeout in milliseconds, defaults to 60000ms<br>*env* `PLAYWRIGHT_MCP_TIMEOUT_NAVIGATION` |
|
||||||
"http://myproxy:3128" or
|
| --user-agent <ua string> | specify user agent string<br>*env* `PLAYWRIGHT_MCP_USER_AGENT` |
|
||||||
"socks5://myproxy:8080"
|
| --user-data-dir <path> | path to the user data directory. If not specified, a temporary directory will be created.<br>*env* `PLAYWRIGHT_MCP_USER_DATA_DIR` |
|
||||||
--save-session Whether to save the Playwright MCP session
|
| --viewport-size <size> | specify browser viewport size in pixels, for example "1280x720"<br>*env* `PLAYWRIGHT_MCP_VIEWPORT_SIZE` |
|
||||||
into the output directory.
|
|
||||||
--save-trace Whether to save the Playwright Trace of the
|
|
||||||
session into the output directory.
|
|
||||||
--secrets <path> path to a file containing secrets in the
|
|
||||||
dotenv format
|
|
||||||
--storage-state <path> path to the storage state file for isolated
|
|
||||||
sessions.
|
|
||||||
--timeout-action <timeout> specify action timeout in milliseconds,
|
|
||||||
defaults to 5000ms
|
|
||||||
--timeout-navigation <timeout> specify navigation timeout in milliseconds,
|
|
||||||
defaults to 60000ms
|
|
||||||
--user-agent <ua string> specify user agent string
|
|
||||||
--user-data-dir <path> path to the user data directory. If not
|
|
||||||
specified, a temporary directory will be
|
|
||||||
created.
|
|
||||||
--viewport-size <size> specify browser viewport size in pixels, for
|
|
||||||
example "1280, 720"
|
|
||||||
```
|
|
||||||
|
|
||||||
<!--- End of options generated section -->
|
<!--- End of options generated section -->
|
||||||
|
|
||||||
@@ -287,7 +423,36 @@ state [here](https://playwright.dev/docs/auth).
|
|||||||
|
|
||||||
**Browser Extension**
|
**Browser Extension**
|
||||||
|
|
||||||
The Playwright MCP Chrome Extension allows you to connect to existing browser tabs and leverage your logged-in sessions and browser state. See [extension/README.md](extension/README.md) for installation and setup instructions.
|
The Playwright MCP Chrome Extension allows you to connect to existing browser tabs and leverage your logged-in sessions and browser state. See [packages/extension/README.md](packages/extension/README.md) for installation and setup instructions.
|
||||||
|
|
||||||
|
### Initial state
|
||||||
|
|
||||||
|
There are multiple ways to provide the initial state to the browser context or a page.
|
||||||
|
|
||||||
|
For the storage state, you can either:
|
||||||
|
- Start with a user data directory using the `--user-data-dir` argument. This will persist all browser data between the sessions.
|
||||||
|
- Start with a storage state file using the `--storage-state` argument. This will load cookies and local storage from the file into an isolated browser context.
|
||||||
|
|
||||||
|
For the page state, you can use:
|
||||||
|
|
||||||
|
- `--init-page` to point to a TypeScript file that will be evaluated on the Playwright page object. This allows you to run arbitrary code to set up the page.
|
||||||
|
|
||||||
|
```ts
|
||||||
|
// init-page.ts
|
||||||
|
export default async ({ page }) => {
|
||||||
|
await page.context().grantPermissions(['geolocation']);
|
||||||
|
await page.context().setGeolocation({ latitude: 37.7749, longitude: -122.4194 });
|
||||||
|
await page.setViewportSize({ width: 1280, height: 720 });
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
- `--init-script` to point to a JavaScript file that will be added as an initialization script. The script will be evaluated in every page before any of the page's scripts.
|
||||||
|
This is useful for overriding browser APIs or setting up the environment.
|
||||||
|
|
||||||
|
```js
|
||||||
|
// init-script.js
|
||||||
|
window.isPlaywrightMCP = true;
|
||||||
|
```
|
||||||
|
|
||||||
### Configuration file
|
### Configuration file
|
||||||
|
|
||||||
@@ -301,75 +466,206 @@ npx @playwright/mcp@latest --config path/to/config.json
|
|||||||
<details>
|
<details>
|
||||||
<summary>Configuration file schema</summary>
|
<summary>Configuration file schema</summary>
|
||||||
|
|
||||||
|
<!--- Config generated by update-readme.js -->
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
{
|
{
|
||||||
// Browser configuration
|
/**
|
||||||
|
* The browser to use.
|
||||||
|
*/
|
||||||
browser?: {
|
browser?: {
|
||||||
// Browser type to use (chromium, firefox, or webkit)
|
/**
|
||||||
|
* The type of browser to use.
|
||||||
|
*/
|
||||||
browserName?: 'chromium' | 'firefox' | 'webkit';
|
browserName?: 'chromium' | 'firefox' | 'webkit';
|
||||||
|
|
||||||
// Keep the browser profile in memory, do not save it to disk.
|
/**
|
||||||
|
* Keep the browser profile in memory, do not save it to disk.
|
||||||
|
*/
|
||||||
isolated?: boolean;
|
isolated?: boolean;
|
||||||
|
|
||||||
// Path to user data directory for browser profile persistence
|
/**
|
||||||
|
* Path to a user data directory for browser profile persistence.
|
||||||
|
* Temporary directory is created by default.
|
||||||
|
*/
|
||||||
userDataDir?: string;
|
userDataDir?: string;
|
||||||
|
|
||||||
// Browser launch options (see Playwright docs)
|
/**
|
||||||
// @see https://playwright.dev/docs/api/class-browsertype#browser-type-launch
|
* Launch options passed to
|
||||||
launchOptions?: {
|
* @see https://playwright.dev/docs/api/class-browsertype#browser-type-launch-persistent-context
|
||||||
channel?: string; // Browser channel (e.g. 'chrome')
|
*
|
||||||
headless?: boolean; // Run in headless mode
|
* This is useful for settings options like `channel`, `headless`, `executablePath`, etc.
|
||||||
executablePath?: string; // Path to browser executable
|
*/
|
||||||
// ... other Playwright launch options
|
launchOptions?: playwright.LaunchOptions;
|
||||||
};
|
|
||||||
|
|
||||||
// Browser context options
|
/**
|
||||||
// @see https://playwright.dev/docs/api/class-browser#browser-new-context
|
* Context options for the browser context.
|
||||||
contextOptions?: {
|
*
|
||||||
viewport?: { width: number, height: number };
|
* This is useful for settings options like `viewport`.
|
||||||
// ... other Playwright context options
|
*/
|
||||||
};
|
contextOptions?: playwright.BrowserContextOptions;
|
||||||
|
|
||||||
// CDP endpoint for connecting to existing browser
|
/**
|
||||||
|
* Chrome DevTools Protocol endpoint to connect to an existing browser instance in case of Chromium family browsers.
|
||||||
|
*/
|
||||||
cdpEndpoint?: string;
|
cdpEndpoint?: string;
|
||||||
|
|
||||||
// Remote Playwright server endpoint
|
/**
|
||||||
|
* CDP headers to send with the connect request.
|
||||||
|
*/
|
||||||
|
cdpHeaders?: Record<string, string>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Timeout in milliseconds for connecting to CDP endpoint. Defaults to 30000 (30 seconds). Pass 0 to disable timeout.
|
||||||
|
*/
|
||||||
|
cdpTimeout?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Remote endpoint to connect to an existing Playwright server.
|
||||||
|
*/
|
||||||
remoteEndpoint?: string;
|
remoteEndpoint?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Paths to TypeScript files to add as initialization scripts for Playwright page.
|
||||||
|
*/
|
||||||
|
initPage?: string[];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Paths to JavaScript files to add as initialization scripts.
|
||||||
|
* The scripts will be evaluated in every page before any of the page's scripts.
|
||||||
|
*/
|
||||||
|
initScript?: string[];
|
||||||
},
|
},
|
||||||
|
|
||||||
// Server configuration
|
|
||||||
server?: {
|
server?: {
|
||||||
port?: number; // Port to listen on
|
/**
|
||||||
host?: string; // Host to bind to (default: localhost)
|
* The port to listen on for SSE or MCP transport.
|
||||||
|
*/
|
||||||
|
port?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The host to bind the server to. Default is localhost. Use 0.0.0.0 to bind to all interfaces.
|
||||||
|
*/
|
||||||
|
host?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The hosts this server is allowed to serve from. Defaults to the host server is bound to.
|
||||||
|
* This is not for CORS, but rather for the DNS rebinding protection.
|
||||||
|
*/
|
||||||
|
allowedHosts?: string[];
|
||||||
},
|
},
|
||||||
|
|
||||||
// List of additional capabilities
|
/**
|
||||||
capabilities?: Array<
|
* List of enabled tool capabilities. Possible values:
|
||||||
'tabs' | // Tab management
|
* - 'core': Core browser automation features.
|
||||||
'install' | // Browser installation
|
* - 'pdf': PDF generation and manipulation.
|
||||||
'pdf' | // PDF generation
|
* - 'vision': Coordinate-based interactions.
|
||||||
'vision' | // Coordinate-based interactions
|
*/
|
||||||
>;
|
capabilities?: ToolCapability[];
|
||||||
|
|
||||||
// Directory for output files
|
/**
|
||||||
|
* Whether to save the Playwright session into the output directory.
|
||||||
|
*/
|
||||||
|
saveSession?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Whether to save the Playwright trace of the session into the output directory.
|
||||||
|
*/
|
||||||
|
saveTrace?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* If specified, saves the Playwright video of the session into the output directory.
|
||||||
|
*/
|
||||||
|
saveVideo?: {
|
||||||
|
width: number;
|
||||||
|
height: number;
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Reuse the same browser context between all connected HTTP clients.
|
||||||
|
*/
|
||||||
|
sharedBrowserContext?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Secrets are used to prevent LLM from getting sensitive data while
|
||||||
|
* automating scenarios such as authentication.
|
||||||
|
* Prefer the browser.contextOptions.storageState over secrets file as a more secure alternative.
|
||||||
|
*/
|
||||||
|
secrets?: Record<string, string>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The directory to save output files.
|
||||||
|
*/
|
||||||
outputDir?: string;
|
outputDir?: string;
|
||||||
|
|
||||||
// Network configuration
|
/**
|
||||||
|
* Whether to save snapshots, console messages, network logs and other session logs to a file or to the standard output. Defaults to "stdout".
|
||||||
|
*/
|
||||||
|
outputMode?: 'file' | 'stdout';
|
||||||
|
|
||||||
|
console?: {
|
||||||
|
/**
|
||||||
|
* The level of console messages to return. Each level includes the messages of more severe levels. Defaults to "info".
|
||||||
|
*/
|
||||||
|
level?: 'error' | 'warning' | 'info' | 'debug';
|
||||||
|
},
|
||||||
|
|
||||||
network?: {
|
network?: {
|
||||||
// List of origins to allow the browser to request. Default is to allow all. Origins matching both `allowedOrigins` and `blockedOrigins` will be blocked.
|
/**
|
||||||
|
* List of origins to allow the browser to request. Default is to allow all. Origins matching both `allowedOrigins` and `blockedOrigins` will be blocked.
|
||||||
|
*/
|
||||||
allowedOrigins?: string[];
|
allowedOrigins?: string[];
|
||||||
|
|
||||||
// List of origins to block the browser to request. Origins matching both `allowedOrigins` and `blockedOrigins` will be blocked.
|
/**
|
||||||
|
* List of origins to block the browser to request. Origins matching both `allowedOrigins` and `blockedOrigins` will be blocked.
|
||||||
|
*/
|
||||||
blockedOrigins?: string[];
|
blockedOrigins?: string[];
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Whether to send image responses to the client. Can be "allow" or "omit".
|
* Specify the attribute to use for test ids, defaults to "data-testid".
|
||||||
* Defaults to "allow".
|
*/
|
||||||
|
testIdAttribute?: string;
|
||||||
|
|
||||||
|
timeouts?: {
|
||||||
|
/*
|
||||||
|
* Configures default action timeout: https://playwright.dev/docs/api/class-page#page-set-default-timeout. Defaults to 5000ms.
|
||||||
|
*/
|
||||||
|
action?: number;
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Configures default navigation timeout: https://playwright.dev/docs/api/class-page#page-set-default-navigation-timeout. Defaults to 60000ms.
|
||||||
|
*/
|
||||||
|
navigation?: number;
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Whether to send image responses to the client. Can be "allow", "omit", or "auto". Defaults to "auto", which sends images if the client can display them.
|
||||||
*/
|
*/
|
||||||
imageResponses?: 'allow' | 'omit';
|
imageResponses?: 'allow' | 'omit';
|
||||||
|
|
||||||
|
snapshot?: {
|
||||||
|
/**
|
||||||
|
* When taking snapshots for responses, specifies the mode to use.
|
||||||
|
*/
|
||||||
|
mode?: 'incremental' | 'full' | 'none';
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Whether to allow file uploads from anywhere on the file system.
|
||||||
|
* By default (false), file uploads are restricted to paths within the MCP roots only.
|
||||||
|
*/
|
||||||
|
allowUnrestrictedFileAccess?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Specify the language to use for code generation.
|
||||||
|
*/
|
||||||
|
codegen?: 'typescript' | 'none';
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
<!--- End of config generated section -->
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
### Standalone MCP server
|
### Standalone MCP server
|
||||||
@@ -409,6 +705,19 @@ And then in MCP client config, set the `url` to the HTTP endpoint:
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Or If you prefer to run the container as a long-lived service instead of letting the MCP client spawn it, use:
|
||||||
|
|
||||||
|
```
|
||||||
|
docker run -d -i --rm --init --pull=always \
|
||||||
|
--entrypoint node \
|
||||||
|
--name playwright \
|
||||||
|
-p 8931:8931 \
|
||||||
|
mcr.microsoft.com/playwright/mcp \
|
||||||
|
cli.js --headless --browser chromium --no-sandbox --port 8931
|
||||||
|
```
|
||||||
|
|
||||||
|
The server will listen on host port **8931** and can be reached by any MCP client.
|
||||||
|
|
||||||
You can build the Docker image yourself.
|
You can build the Docker image yourself.
|
||||||
|
|
||||||
```
|
```
|
||||||
@@ -431,7 +740,7 @@ http.createServer(async (req, res) => {
|
|||||||
// Creates a headless Playwright MCP server with SSE transport
|
// Creates a headless Playwright MCP server with SSE transport
|
||||||
const connection = await createConnection({ browser: { launchOptions: { headless: true } } });
|
const connection = await createConnection({ browser: { launchOptions: { headless: true } } });
|
||||||
const transport = new SSEServerTransport('/messages', res);
|
const transport = new SSEServerTransport('/messages', res);
|
||||||
await connection.sever.connect(transport);
|
await connection.connect(transport);
|
||||||
|
|
||||||
// ...
|
// ...
|
||||||
});
|
});
|
||||||
@@ -451,7 +760,7 @@ http.createServer(async (req, res) => {
|
|||||||
- Title: Click
|
- Title: Click
|
||||||
- Description: Perform click on a web page
|
- Description: Perform click on a web page
|
||||||
- Parameters:
|
- Parameters:
|
||||||
- `element` (string): Human-readable element description used to obtain permission to interact with the element
|
- `element` (string, optional): Human-readable element description used to obtain permission to interact with the element
|
||||||
- `ref` (string): Exact target element reference from the page snapshot
|
- `ref` (string): Exact target element reference from the page snapshot
|
||||||
- `doubleClick` (boolean, optional): Whether to perform a double click instead of a single click
|
- `doubleClick` (boolean, optional): Whether to perform a double click instead of a single click
|
||||||
- `button` (string, optional): Button to click, defaults to left
|
- `button` (string, optional): Button to click, defaults to left
|
||||||
@@ -464,14 +773,16 @@ http.createServer(async (req, res) => {
|
|||||||
- Title: Close browser
|
- Title: Close browser
|
||||||
- Description: Close the page
|
- Description: Close the page
|
||||||
- Parameters: None
|
- Parameters: None
|
||||||
- Read-only: **true**
|
- Read-only: **false**
|
||||||
|
|
||||||
<!-- NOTE: This has been generated via update-readme.js -->
|
<!-- NOTE: This has been generated via update-readme.js -->
|
||||||
|
|
||||||
- **browser_console_messages**
|
- **browser_console_messages**
|
||||||
- Title: Get console messages
|
- Title: Get console messages
|
||||||
- Description: Returns all console messages
|
- Description: Returns all console messages
|
||||||
- Parameters: None
|
- Parameters:
|
||||||
|
- `level` (string): Level of the console messages to return. Each level includes the messages of more severe levels. Defaults to "info".
|
||||||
|
- `filename` (string, optional): Filename to save the console messages to. If not provided, messages are returned as text.
|
||||||
- Read-only: **true**
|
- Read-only: **true**
|
||||||
|
|
||||||
<!-- NOTE: This has been generated via update-readme.js -->
|
<!-- NOTE: This has been generated via update-readme.js -->
|
||||||
@@ -503,7 +814,7 @@ http.createServer(async (req, res) => {
|
|||||||
- Title: Upload files
|
- Title: Upload files
|
||||||
- Description: Upload one or multiple files
|
- Description: Upload one or multiple files
|
||||||
- Parameters:
|
- Parameters:
|
||||||
- `paths` (array): The absolute paths to the files to upload. Can be a single file or multiple files.
|
- `paths` (array, optional): The absolute paths to the files to upload. Can be single file or multiple files. If omitted, file chooser is cancelled.
|
||||||
- Read-only: **false**
|
- Read-only: **false**
|
||||||
|
|
||||||
<!-- NOTE: This has been generated via update-readme.js -->
|
<!-- NOTE: This has been generated via update-readme.js -->
|
||||||
@@ -531,9 +842,9 @@ http.createServer(async (req, res) => {
|
|||||||
- Title: Hover mouse
|
- Title: Hover mouse
|
||||||
- Description: Hover over element on page
|
- Description: Hover over element on page
|
||||||
- Parameters:
|
- Parameters:
|
||||||
- `element` (string): Human-readable element description used to obtain permission to interact with the element
|
- `element` (string, optional): Human-readable element description used to obtain permission to interact with the element
|
||||||
- `ref` (string): Exact target element reference from the page snapshot
|
- `ref` (string): Exact target element reference from the page snapshot
|
||||||
- Read-only: **true**
|
- Read-only: **false**
|
||||||
|
|
||||||
<!-- NOTE: This has been generated via update-readme.js -->
|
<!-- NOTE: This has been generated via update-readme.js -->
|
||||||
|
|
||||||
@@ -548,16 +859,18 @@ http.createServer(async (req, res) => {
|
|||||||
|
|
||||||
- **browser_navigate_back**
|
- **browser_navigate_back**
|
||||||
- Title: Go back
|
- Title: Go back
|
||||||
- Description: Go back to the previous page
|
- Description: Go back to the previous page in the history
|
||||||
- Parameters: None
|
- Parameters: None
|
||||||
- Read-only: **true**
|
- Read-only: **false**
|
||||||
|
|
||||||
<!-- NOTE: This has been generated via update-readme.js -->
|
<!-- NOTE: This has been generated via update-readme.js -->
|
||||||
|
|
||||||
- **browser_network_requests**
|
- **browser_network_requests**
|
||||||
- Title: List network requests
|
- Title: List network requests
|
||||||
- Description: Returns all network requests since loading the page
|
- Description: Returns all network requests since loading the page
|
||||||
- Parameters: None
|
- Parameters:
|
||||||
|
- `includeStatic` (boolean): Whether to include successful static resources like images, fonts, scripts, etc. Defaults to false.
|
||||||
|
- `filename` (string, optional): Filename to save the network requests to. If not provided, requests are returned as text.
|
||||||
- Read-only: **true**
|
- Read-only: **true**
|
||||||
|
|
||||||
<!-- NOTE: This has been generated via update-readme.js -->
|
<!-- NOTE: This has been generated via update-readme.js -->
|
||||||
@@ -577,7 +890,16 @@ http.createServer(async (req, res) => {
|
|||||||
- Parameters:
|
- Parameters:
|
||||||
- `width` (number): Width of the browser window
|
- `width` (number): Width of the browser window
|
||||||
- `height` (number): Height of the browser window
|
- `height` (number): Height of the browser window
|
||||||
- Read-only: **true**
|
- Read-only: **false**
|
||||||
|
|
||||||
|
<!-- NOTE: This has been generated via update-readme.js -->
|
||||||
|
|
||||||
|
- **browser_run_code**
|
||||||
|
- Title: Run Playwright code
|
||||||
|
- Description: Run Playwright code snippet
|
||||||
|
- Parameters:
|
||||||
|
- `code` (string): A JavaScript function containing Playwright code to execute. It will be invoked with a single argument, page, which you can use for any page interaction. For example: `async (page) => { await page.getByRole('button', { name: 'Submit' }).click(); return await page.title(); }`
|
||||||
|
- Read-only: **false**
|
||||||
|
|
||||||
<!-- NOTE: This has been generated via update-readme.js -->
|
<!-- NOTE: This has been generated via update-readme.js -->
|
||||||
|
|
||||||
@@ -585,7 +907,7 @@ http.createServer(async (req, res) => {
|
|||||||
- Title: Select option
|
- Title: Select option
|
||||||
- Description: Select an option in a dropdown
|
- Description: Select an option in a dropdown
|
||||||
- Parameters:
|
- Parameters:
|
||||||
- `element` (string): Human-readable element description used to obtain permission to interact with the element
|
- `element` (string, optional): Human-readable element description used to obtain permission to interact with the element
|
||||||
- `ref` (string): Exact target element reference from the page snapshot
|
- `ref` (string): Exact target element reference from the page snapshot
|
||||||
- `values` (array): Array of values to select in the dropdown. This can be a single value or multiple values.
|
- `values` (array): Array of values to select in the dropdown. This can be a single value or multiple values.
|
||||||
- Read-only: **false**
|
- Read-only: **false**
|
||||||
@@ -595,7 +917,8 @@ http.createServer(async (req, res) => {
|
|||||||
- **browser_snapshot**
|
- **browser_snapshot**
|
||||||
- Title: Page snapshot
|
- Title: Page snapshot
|
||||||
- Description: Capture accessibility snapshot of the current page, this is better than screenshot
|
- Description: Capture accessibility snapshot of the current page, this is better than screenshot
|
||||||
- Parameters: None
|
- Parameters:
|
||||||
|
- `filename` (string, optional): Save snapshot to markdown file instead of returning it in the response.
|
||||||
- Read-only: **true**
|
- Read-only: **true**
|
||||||
|
|
||||||
<!-- NOTE: This has been generated via update-readme.js -->
|
<!-- NOTE: This has been generated via update-readme.js -->
|
||||||
@@ -604,8 +927,8 @@ http.createServer(async (req, res) => {
|
|||||||
- Title: Take a screenshot
|
- Title: Take a screenshot
|
||||||
- Description: Take a screenshot of the current page. You can't perform actions based on the screenshot, use browser_snapshot for actions.
|
- Description: Take a screenshot of the current page. You can't perform actions based on the screenshot, use browser_snapshot for actions.
|
||||||
- Parameters:
|
- Parameters:
|
||||||
- `type` (string, optional): Image format for the screenshot. Default is png.
|
- `type` (string): Image format for the screenshot. Default is png.
|
||||||
- `filename` (string, optional): File name to save the screenshot to. Defaults to `page-{timestamp}.{png|jpeg}` if not specified.
|
- `filename` (string, optional): File name to save the screenshot to. Defaults to `page-{timestamp}.{png|jpeg}` if not specified. Prefer relative file names to stay within the output directory.
|
||||||
- `element` (string, optional): Human-readable element description used to obtain permission to screenshot the element. If not provided, the screenshot will be taken of viewport. If element is provided, ref must be provided too.
|
- `element` (string, optional): Human-readable element description used to obtain permission to screenshot the element. If not provided, the screenshot will be taken of viewport. If element is provided, ref must be provided too.
|
||||||
- `ref` (string, optional): Exact target element reference from the page snapshot. If not provided, the screenshot will be taken of viewport. If ref is provided, element must be provided too.
|
- `ref` (string, optional): Exact target element reference from the page snapshot. If not provided, the screenshot will be taken of viewport. If ref is provided, element must be provided too.
|
||||||
- `fullPage` (boolean, optional): When true, takes a screenshot of the full scrollable page, instead of the currently visible viewport. Cannot be used with element screenshots.
|
- `fullPage` (boolean, optional): When true, takes a screenshot of the full scrollable page, instead of the currently visible viewport. Cannot be used with element screenshots.
|
||||||
@@ -617,7 +940,7 @@ http.createServer(async (req, res) => {
|
|||||||
- Title: Type text
|
- Title: Type text
|
||||||
- Description: Type text into editable element
|
- Description: Type text into editable element
|
||||||
- Parameters:
|
- Parameters:
|
||||||
- `element` (string): Human-readable element description used to obtain permission to interact with the element
|
- `element` (string, optional): Human-readable element description used to obtain permission to interact with the element
|
||||||
- `ref` (string): Exact target element reference from the page snapshot
|
- `ref` (string): Exact target element reference from the page snapshot
|
||||||
- `text` (string): Text to type into the element
|
- `text` (string): Text to type into the element
|
||||||
- `submit` (boolean, optional): Whether to submit entered text (press Enter after)
|
- `submit` (boolean, optional): Whether to submit entered text (press Enter after)
|
||||||
@@ -633,7 +956,7 @@ http.createServer(async (req, res) => {
|
|||||||
- `time` (number, optional): The time to wait in seconds
|
- `time` (number, optional): The time to wait in seconds
|
||||||
- `text` (string, optional): The text to wait for
|
- `text` (string, optional): The text to wait for
|
||||||
- `textGone` (string, optional): The text to wait for to disappear
|
- `textGone` (string, optional): The text to wait for to disappear
|
||||||
- Read-only: **true**
|
- Read-only: **false**
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
@@ -674,18 +997,25 @@ http.createServer(async (req, res) => {
|
|||||||
- Title: Click
|
- Title: Click
|
||||||
- Description: Click left mouse button at a given position
|
- Description: Click left mouse button at a given position
|
||||||
- Parameters:
|
- Parameters:
|
||||||
- `element` (string): Human-readable element description used to obtain permission to interact with the element
|
|
||||||
- `x` (number): X coordinate
|
- `x` (number): X coordinate
|
||||||
- `y` (number): Y coordinate
|
- `y` (number): Y coordinate
|
||||||
- Read-only: **false**
|
- Read-only: **false**
|
||||||
|
|
||||||
<!-- NOTE: This has been generated via update-readme.js -->
|
<!-- NOTE: This has been generated via update-readme.js -->
|
||||||
|
|
||||||
|
- **browser_mouse_down**
|
||||||
|
- Title: Press mouse down
|
||||||
|
- Description: Press mouse down
|
||||||
|
- Parameters:
|
||||||
|
- `button` (string, optional): Button to press, defaults to left
|
||||||
|
- Read-only: **false**
|
||||||
|
|
||||||
|
<!-- NOTE: This has been generated via update-readme.js -->
|
||||||
|
|
||||||
- **browser_mouse_drag_xy**
|
- **browser_mouse_drag_xy**
|
||||||
- Title: Drag mouse
|
- Title: Drag mouse
|
||||||
- Description: Drag left mouse button to a given position
|
- Description: Drag left mouse button to a given position
|
||||||
- Parameters:
|
- Parameters:
|
||||||
- `element` (string): Human-readable element description used to obtain permission to interact with the element
|
|
||||||
- `startX` (number): Start X coordinate
|
- `startX` (number): Start X coordinate
|
||||||
- `startY` (number): Start Y coordinate
|
- `startY` (number): Start Y coordinate
|
||||||
- `endX` (number): End X coordinate
|
- `endX` (number): End X coordinate
|
||||||
@@ -698,10 +1028,28 @@ http.createServer(async (req, res) => {
|
|||||||
- Title: Move mouse
|
- Title: Move mouse
|
||||||
- Description: Move mouse to a given position
|
- Description: Move mouse to a given position
|
||||||
- Parameters:
|
- Parameters:
|
||||||
- `element` (string): Human-readable element description used to obtain permission to interact with the element
|
|
||||||
- `x` (number): X coordinate
|
- `x` (number): X coordinate
|
||||||
- `y` (number): Y coordinate
|
- `y` (number): Y coordinate
|
||||||
- Read-only: **true**
|
- Read-only: **false**
|
||||||
|
|
||||||
|
<!-- NOTE: This has been generated via update-readme.js -->
|
||||||
|
|
||||||
|
- **browser_mouse_up**
|
||||||
|
- Title: Press mouse up
|
||||||
|
- Description: Press mouse up
|
||||||
|
- Parameters:
|
||||||
|
- `button` (string, optional): Button to press, defaults to left
|
||||||
|
- Read-only: **false**
|
||||||
|
|
||||||
|
<!-- NOTE: This has been generated via update-readme.js -->
|
||||||
|
|
||||||
|
- **browser_mouse_wheel**
|
||||||
|
- Title: Scroll mouse wheel
|
||||||
|
- Description: Scroll mouse wheel
|
||||||
|
- Parameters:
|
||||||
|
- `deltaX` (number): X delta
|
||||||
|
- `deltaY` (number): Y delta
|
||||||
|
- Read-only: **false**
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
@@ -714,13 +1062,23 @@ http.createServer(async (req, res) => {
|
|||||||
- Title: Save as PDF
|
- Title: Save as PDF
|
||||||
- Description: Save page as PDF
|
- Description: Save page as PDF
|
||||||
- Parameters:
|
- Parameters:
|
||||||
- `filename` (string, optional): File name to save the pdf to. Defaults to `page-{timestamp}.pdf` if not specified.
|
- `filename` (string, optional): File name to save the pdf to. Defaults to `page-{timestamp}.pdf` if not specified. Prefer relative file names to stay within the output directory.
|
||||||
- Read-only: **true**
|
- Read-only: **true**
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
<summary><b>Verify (opt-in via --caps=verify)</b></summary>
|
<summary><b>Test assertions (opt-in via --caps=testing)</b></summary>
|
||||||
|
|
||||||
|
<!-- NOTE: This has been generated via update-readme.js -->
|
||||||
|
|
||||||
|
- **browser_generate_locator**
|
||||||
|
- Title: Create locator for element
|
||||||
|
- Description: Generate locator for the given element to use in tests
|
||||||
|
- Parameters:
|
||||||
|
- `element` (string, optional): Human-readable element description used to obtain permission to interact with the element
|
||||||
|
- `ref` (string): Exact target element reference from the page snapshot
|
||||||
|
- Read-only: **true**
|
||||||
|
|
||||||
<!-- NOTE: This has been generated via update-readme.js -->
|
<!-- NOTE: This has been generated via update-readme.js -->
|
||||||
|
|
||||||
@@ -730,7 +1088,7 @@ http.createServer(async (req, res) => {
|
|||||||
- Parameters:
|
- Parameters:
|
||||||
- `role` (string): ROLE of the element. Can be found in the snapshot like this: `- {ROLE} "Accessible Name":`
|
- `role` (string): ROLE of the element. Can be found in the snapshot like this: `- {ROLE} "Accessible Name":`
|
||||||
- `accessibleName` (string): ACCESSIBLE_NAME of the element. Can be found in the snapshot like this: `- role "{ACCESSIBLE_NAME}"`
|
- `accessibleName` (string): ACCESSIBLE_NAME of the element. Can be found in the snapshot like this: `- role "{ACCESSIBLE_NAME}"`
|
||||||
- Read-only: **true**
|
- Read-only: **false**
|
||||||
|
|
||||||
<!-- NOTE: This has been generated via update-readme.js -->
|
<!-- NOTE: This has been generated via update-readme.js -->
|
||||||
|
|
||||||
@@ -741,7 +1099,7 @@ http.createServer(async (req, res) => {
|
|||||||
- `element` (string): Human-readable list description
|
- `element` (string): Human-readable list description
|
||||||
- `ref` (string): Exact target element reference that points to the list
|
- `ref` (string): Exact target element reference that points to the list
|
||||||
- `items` (array): Items to verify
|
- `items` (array): Items to verify
|
||||||
- Read-only: **true**
|
- Read-only: **false**
|
||||||
|
|
||||||
<!-- NOTE: This has been generated via update-readme.js -->
|
<!-- NOTE: This has been generated via update-readme.js -->
|
||||||
|
|
||||||
@@ -750,7 +1108,7 @@ http.createServer(async (req, res) => {
|
|||||||
- Description: Verify text is visible on the page. Prefer browser_verify_element_visible if possible.
|
- Description: Verify text is visible on the page. Prefer browser_verify_element_visible if possible.
|
||||||
- Parameters:
|
- Parameters:
|
||||||
- `text` (string): TEXT to verify. Can be found in the snapshot like this: `- role "Accessible Name": {TEXT}` or like this: `- text: {TEXT}`
|
- `text` (string): TEXT to verify. Can be found in the snapshot like this: `- role "Accessible Name": {TEXT}` or like this: `- text: {TEXT}`
|
||||||
- Read-only: **true**
|
- Read-only: **false**
|
||||||
|
|
||||||
<!-- NOTE: This has been generated via update-readme.js -->
|
<!-- NOTE: This has been generated via update-readme.js -->
|
||||||
|
|
||||||
@@ -762,7 +1120,7 @@ http.createServer(async (req, res) => {
|
|||||||
- `element` (string): Human-readable element description
|
- `element` (string): Human-readable element description
|
||||||
- `ref` (string): Exact target element reference that points to the element
|
- `ref` (string): Exact target element reference that points to the element
|
||||||
- `value` (string): Value to verify. For checkbox, use "true" or "false".
|
- `value` (string): Value to verify. For checkbox, use "true" or "false".
|
||||||
- Read-only: **true**
|
- Read-only: **false**
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
|
|||||||
1884
extension/package-lock.json
generated
@@ -1,306 +0,0 @@
|
|||||||
/**
|
|
||||||
* Copyright (c) Microsoft Corporation.
|
|
||||||
*
|
|
||||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
||||||
* you may not use this file except in compliance with the License.
|
|
||||||
* You may obtain a copy of the License at
|
|
||||||
*
|
|
||||||
* http://www.apache.org/licenses/LICENSE-2.0
|
|
||||||
*
|
|
||||||
* Unless required by applicable law or agreed to in writing, software
|
|
||||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
||||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
||||||
* See the License for the specific language governing permissions and
|
|
||||||
* limitations under the License.
|
|
||||||
*/
|
|
||||||
|
|
||||||
import fs from 'fs';
|
|
||||||
import path from 'path';
|
|
||||||
import { chromium } from 'playwright';
|
|
||||||
import { test as base, expect } from '../../tests/fixtures';
|
|
||||||
|
|
||||||
import type { Client } from '@modelcontextprotocol/sdk/client/index.js';
|
|
||||||
import type { BrowserContext } from 'playwright';
|
|
||||||
import type { StartClient } from '../../tests/fixtures';
|
|
||||||
|
|
||||||
type BrowserWithExtension = {
|
|
||||||
userDataDir: string;
|
|
||||||
launch: (mode?: 'disable-extension') => Promise<BrowserContext>;
|
|
||||||
};
|
|
||||||
|
|
||||||
type TestFixtures = {
|
|
||||||
browserWithExtension: BrowserWithExtension,
|
|
||||||
pathToExtension: string,
|
|
||||||
useShortConnectionTimeout: (timeoutMs: number) => void
|
|
||||||
overrideProtocolVersion: (version: number) => void
|
|
||||||
};
|
|
||||||
|
|
||||||
const test = base.extend<TestFixtures>({
|
|
||||||
pathToExtension: async ({}, use) => {
|
|
||||||
await use(path.resolve(__dirname, '../dist'));
|
|
||||||
},
|
|
||||||
|
|
||||||
browserWithExtension: async ({ mcpBrowser, pathToExtension }, use, testInfo) => {
|
|
||||||
// The flags no longer work in Chrome since
|
|
||||||
// https://chromium.googlesource.com/chromium/src/+/290ed8046692651ce76088914750cb659b65fb17%5E%21/chrome/browser/extensions/extension_service.cc?pli=1#
|
|
||||||
test.skip('chromium' !== mcpBrowser, '--load-extension is not supported for official builds of Chromium');
|
|
||||||
|
|
||||||
let browserContext: BrowserContext | undefined;
|
|
||||||
const userDataDir = testInfo.outputPath('extension-user-data-dir');
|
|
||||||
await use({
|
|
||||||
userDataDir,
|
|
||||||
launch: async (mode?: 'disable-extension') => {
|
|
||||||
browserContext = await chromium.launchPersistentContext(userDataDir, {
|
|
||||||
channel: mcpBrowser,
|
|
||||||
// Opening the browser singleton only works in headed.
|
|
||||||
headless: false,
|
|
||||||
// Automation disables singleton browser process behavior, which is necessary for the extension.
|
|
||||||
ignoreDefaultArgs: ['--enable-automation'],
|
|
||||||
args: mode === 'disable-extension' ? [] : [
|
|
||||||
`--disable-extensions-except=${pathToExtension}`,
|
|
||||||
`--load-extension=${pathToExtension}`,
|
|
||||||
],
|
|
||||||
});
|
|
||||||
|
|
||||||
// for manifest v3:
|
|
||||||
let [serviceWorker] = browserContext.serviceWorkers();
|
|
||||||
if (!serviceWorker)
|
|
||||||
serviceWorker = await browserContext.waitForEvent('serviceworker');
|
|
||||||
|
|
||||||
return browserContext;
|
|
||||||
}
|
|
||||||
});
|
|
||||||
await browserContext?.close();
|
|
||||||
},
|
|
||||||
|
|
||||||
useShortConnectionTimeout: async ({}, use) => {
|
|
||||||
await use((timeoutMs: number) => {
|
|
||||||
process.env.PWMCP_TEST_CONNECTION_TIMEOUT = timeoutMs.toString();
|
|
||||||
});
|
|
||||||
process.env.PWMCP_TEST_CONNECTION_TIMEOUT = undefined;
|
|
||||||
},
|
|
||||||
|
|
||||||
overrideProtocolVersion: async ({}, use) => {
|
|
||||||
await use((version: number) => {
|
|
||||||
process.env.PWMCP_TEST_PROTOCOL_VERSION = version.toString();
|
|
||||||
});
|
|
||||||
process.env.PWMCP_TEST_PROTOCOL_VERSION = undefined;
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
async function startAndCallConnectTool(browserWithExtension: BrowserWithExtension, startClient: StartClient): Promise<Client> {
|
|
||||||
const { client } = await startClient({
|
|
||||||
args: [`--connect-tool`],
|
|
||||||
config: {
|
|
||||||
browser: {
|
|
||||||
userDataDir: browserWithExtension.userDataDir,
|
|
||||||
}
|
|
||||||
},
|
|
||||||
});
|
|
||||||
|
|
||||||
expect(await client.callTool({
|
|
||||||
name: 'browser_connect',
|
|
||||||
arguments: {
|
|
||||||
name: 'extension'
|
|
||||||
}
|
|
||||||
})).toHaveResponse({
|
|
||||||
result: 'Successfully changed connection method.',
|
|
||||||
});
|
|
||||||
|
|
||||||
return client;
|
|
||||||
}
|
|
||||||
|
|
||||||
async function startWithExtensionFlag(browserWithExtension: BrowserWithExtension, startClient: StartClient): Promise<Client> {
|
|
||||||
const { client } = await startClient({
|
|
||||||
args: [`--extension`],
|
|
||||||
config: {
|
|
||||||
browser: {
|
|
||||||
userDataDir: browserWithExtension.userDataDir,
|
|
||||||
}
|
|
||||||
},
|
|
||||||
});
|
|
||||||
return client;
|
|
||||||
}
|
|
||||||
|
|
||||||
const testWithOldExtensionVersion = test.extend({
|
|
||||||
pathToExtension: async ({}, use, testInfo) => {
|
|
||||||
const extensionDir = testInfo.outputPath('extension');
|
|
||||||
const oldPath = path.resolve(__dirname, '../dist');
|
|
||||||
|
|
||||||
await fs.promises.cp(oldPath, extensionDir, { recursive: true });
|
|
||||||
const manifestPath = path.join(extensionDir, 'manifest.json');
|
|
||||||
const manifest = JSON.parse(await fs.promises.readFile(manifestPath, 'utf8'));
|
|
||||||
manifest.version = '0.0.1';
|
|
||||||
await fs.promises.writeFile(manifestPath, JSON.stringify(manifest, null, 2) + '\n');
|
|
||||||
|
|
||||||
await use(extensionDir);
|
|
||||||
},
|
|
||||||
});
|
|
||||||
|
|
||||||
for (const [mode, startClientMethod] of [
|
|
||||||
['connect-tool', startAndCallConnectTool],
|
|
||||||
['extension-flag', startWithExtensionFlag],
|
|
||||||
] as const) {
|
|
||||||
|
|
||||||
test(`navigate with extension (${mode})`, async ({ browserWithExtension, startClient, server }) => {
|
|
||||||
const browserContext = await browserWithExtension.launch();
|
|
||||||
|
|
||||||
const client = await startClientMethod(browserWithExtension, startClient);
|
|
||||||
|
|
||||||
const confirmationPagePromise = browserContext.waitForEvent('page', page => {
|
|
||||||
return page.url().startsWith('chrome-extension://jakfalbnbhgkpmoaakfflhflbfpkailf/connect.html');
|
|
||||||
});
|
|
||||||
|
|
||||||
const navigateResponse = client.callTool({
|
|
||||||
name: 'browser_navigate',
|
|
||||||
arguments: { url: server.HELLO_WORLD },
|
|
||||||
});
|
|
||||||
|
|
||||||
const selectorPage = await confirmationPagePromise;
|
|
||||||
// For browser_navigate command, the UI shows Allow/Reject buttons instead of tab selector
|
|
||||||
await selectorPage.getByRole('button', { name: 'Allow' }).click();
|
|
||||||
|
|
||||||
expect(await navigateResponse).toHaveResponse({
|
|
||||||
pageState: expect.stringContaining(`- generic [active] [ref=e1]: Hello, world!`),
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
test(`snapshot of an existing page (${mode})`, async ({ browserWithExtension, startClient, server }) => {
|
|
||||||
const browserContext = await browserWithExtension.launch();
|
|
||||||
|
|
||||||
const page = await browserContext.newPage();
|
|
||||||
await page.goto(server.HELLO_WORLD);
|
|
||||||
|
|
||||||
// Another empty page.
|
|
||||||
await browserContext.newPage();
|
|
||||||
expect(browserContext.pages()).toHaveLength(3);
|
|
||||||
|
|
||||||
const client = await startClientMethod(browserWithExtension, startClient);
|
|
||||||
expect(browserContext.pages()).toHaveLength(3);
|
|
||||||
|
|
||||||
const confirmationPagePromise = browserContext.waitForEvent('page', page => {
|
|
||||||
return page.url().startsWith('chrome-extension://jakfalbnbhgkpmoaakfflhflbfpkailf/connect.html');
|
|
||||||
});
|
|
||||||
|
|
||||||
const navigateResponse = client.callTool({
|
|
||||||
name: 'browser_snapshot',
|
|
||||||
arguments: { },
|
|
||||||
});
|
|
||||||
|
|
||||||
const selectorPage = await confirmationPagePromise;
|
|
||||||
expect(browserContext.pages()).toHaveLength(4);
|
|
||||||
|
|
||||||
await selectorPage.locator('.tab-item', { hasText: 'Title' }).getByRole('button', { name: 'Connect' }).click();
|
|
||||||
|
|
||||||
expect(await navigateResponse).toHaveResponse({
|
|
||||||
pageState: expect.stringContaining(`- generic [active] [ref=e1]: Hello, world!`),
|
|
||||||
});
|
|
||||||
|
|
||||||
expect(browserContext.pages()).toHaveLength(4);
|
|
||||||
});
|
|
||||||
|
|
||||||
test(`extension not installed timeout (${mode})`, async ({ browserWithExtension, startClient, server, useShortConnectionTimeout }) => {
|
|
||||||
useShortConnectionTimeout(100);
|
|
||||||
|
|
||||||
const browserContext = await browserWithExtension.launch();
|
|
||||||
|
|
||||||
const client = await startClientMethod(browserWithExtension, startClient);
|
|
||||||
|
|
||||||
const confirmationPagePromise = browserContext.waitForEvent('page', page => {
|
|
||||||
return page.url().startsWith('chrome-extension://jakfalbnbhgkpmoaakfflhflbfpkailf/connect.html');
|
|
||||||
});
|
|
||||||
|
|
||||||
expect(await client.callTool({
|
|
||||||
name: 'browser_navigate',
|
|
||||||
arguments: { url: server.HELLO_WORLD },
|
|
||||||
})).toHaveResponse({
|
|
||||||
result: expect.stringContaining('Extension connection timeout. Make sure the "Playwright MCP Bridge" extension is installed.'),
|
|
||||||
isError: true,
|
|
||||||
});
|
|
||||||
|
|
||||||
await confirmationPagePromise;
|
|
||||||
});
|
|
||||||
|
|
||||||
testWithOldExtensionVersion(`works with old extension version (${mode})`, async ({ browserWithExtension, startClient, server, useShortConnectionTimeout }) => {
|
|
||||||
useShortConnectionTimeout(500);
|
|
||||||
|
|
||||||
// Prelaunch the browser, so that it is properly closed after the test.
|
|
||||||
const browserContext = await browserWithExtension.launch();
|
|
||||||
|
|
||||||
const client = await startClientMethod(browserWithExtension, startClient);
|
|
||||||
|
|
||||||
const confirmationPagePromise = browserContext.waitForEvent('page', page => {
|
|
||||||
return page.url().startsWith('chrome-extension://jakfalbnbhgkpmoaakfflhflbfpkailf/connect.html');
|
|
||||||
});
|
|
||||||
|
|
||||||
const navigateResponse = client.callTool({
|
|
||||||
name: 'browser_navigate',
|
|
||||||
arguments: { url: server.HELLO_WORLD },
|
|
||||||
});
|
|
||||||
|
|
||||||
const selectorPage = await confirmationPagePromise;
|
|
||||||
// For browser_navigate command, the UI shows Allow/Reject buttons instead of tab selector
|
|
||||||
await selectorPage.getByRole('button', { name: 'Allow' }).click();
|
|
||||||
|
|
||||||
expect(await navigateResponse).toHaveResponse({
|
|
||||||
pageState: expect.stringContaining(`- generic [active] [ref=e1]: Hello, world!`),
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
test(`extension needs update (${mode})`, async ({ browserWithExtension, startClient, server, useShortConnectionTimeout, overrideProtocolVersion }) => {
|
|
||||||
useShortConnectionTimeout(500);
|
|
||||||
overrideProtocolVersion(1000);
|
|
||||||
|
|
||||||
// Prelaunch the browser, so that it is properly closed after the test.
|
|
||||||
const browserContext = await browserWithExtension.launch();
|
|
||||||
|
|
||||||
const client = await startClientMethod(browserWithExtension, startClient);
|
|
||||||
|
|
||||||
const confirmationPagePromise = browserContext.waitForEvent('page', page => {
|
|
||||||
return page.url().startsWith('chrome-extension://jakfalbnbhgkpmoaakfflhflbfpkailf/connect.html');
|
|
||||||
});
|
|
||||||
|
|
||||||
const navigateResponse = client.callTool({
|
|
||||||
name: 'browser_navigate',
|
|
||||||
arguments: { url: server.HELLO_WORLD },
|
|
||||||
});
|
|
||||||
|
|
||||||
const confirmationPage = await confirmationPagePromise;
|
|
||||||
await expect(confirmationPage.locator('.status-banner')).toContainText(`Playwright MCP version trying to connect requires newer extension version`);
|
|
||||||
|
|
||||||
expect(await navigateResponse).toHaveResponse({
|
|
||||||
result: expect.stringContaining('Extension connection timeout.'),
|
|
||||||
isError: true,
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
||||||
test(`custom executablePath`, async ({ startClient, server, useShortConnectionTimeout }) => {
|
|
||||||
useShortConnectionTimeout(1000);
|
|
||||||
|
|
||||||
const executablePath = test.info().outputPath('echo.sh');
|
|
||||||
await fs.promises.writeFile(executablePath, '#!/bin/bash\necho "Custom exec args: $@" > "$(dirname "$0")/output.txt"', { mode: 0o755 });
|
|
||||||
|
|
||||||
const { client } = await startClient({
|
|
||||||
args: [`--extension`],
|
|
||||||
config: {
|
|
||||||
browser: {
|
|
||||||
launchOptions: {
|
|
||||||
executablePath,
|
|
||||||
},
|
|
||||||
}
|
|
||||||
},
|
|
||||||
});
|
|
||||||
|
|
||||||
const navigateResponse = await client.callTool({
|
|
||||||
name: 'browser_navigate',
|
|
||||||
arguments: { url: server.HELLO_WORLD },
|
|
||||||
timeout: 1000,
|
|
||||||
});
|
|
||||||
expect(await navigateResponse).toHaveResponse({
|
|
||||||
result: expect.stringContaining('Extension connection timeout.'),
|
|
||||||
isError: true,
|
|
||||||
});
|
|
||||||
expect(await fs.promises.readFile(test.info().outputPath('output.txt'), 'utf8')).toContain('Custom exec args: chrome-extension://jakfalbnbhgkpmoaakfflhflbfpkailf/connect.html?');
|
|
||||||
});
|
|
||||||
2486
package-lock.json
generated
46
package.json
@@ -1,48 +1,30 @@
|
|||||||
{
|
{
|
||||||
"name": "@playwright/mcp",
|
"name": "playwright-mcp-internal",
|
||||||
"version": "0.0.37",
|
"version": "0.0.61",
|
||||||
"description": "Playwright Tools for MCP",
|
"private": true,
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
"url": "git+https://github.com/microsoft/playwright-mcp.git"
|
"url": "git+https://github.com/microsoft/playwright-mcp.git"
|
||||||
},
|
},
|
||||||
"homepage": "https://playwright.dev",
|
"homepage": "https://playwright.dev",
|
||||||
"engines": {
|
|
||||||
"node": ">=18"
|
|
||||||
},
|
|
||||||
"author": {
|
"author": {
|
||||||
"name": "Microsoft Corporation"
|
"name": "Microsoft Corporation"
|
||||||
},
|
},
|
||||||
"license": "Apache-2.0",
|
"license": "Apache-2.0",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"lint": "npm run update-readme",
|
|
||||||
"update-readme": "node update-readme.js",
|
|
||||||
"docker-build": "docker build --no-cache -t playwright-mcp-dev:latest .",
|
"docker-build": "docker build --no-cache -t playwright-mcp-dev:latest .",
|
||||||
"test": "playwright test",
|
"docker-rm": "docker rm playwright-mcp-dev",
|
||||||
"ctest": "playwright test --project=chrome",
|
"docker-run": "docker run -it -p 8080:8080 --name playwright-mcp-dev playwright-mcp-dev:latest",
|
||||||
"ftest": "playwright test --project=firefox",
|
"lint": "npm run lint --workspaces",
|
||||||
"wtest": "playwright test --project=webkit",
|
"test": "npm run test --workspaces",
|
||||||
"dtest": "MCP_IN_DOCKER=1 playwright test --project=chromium-docker",
|
"build": "npm run build --workspaces"
|
||||||
"npm-publish": "npm run clean && npm run test && npm publish"
|
|
||||||
},
|
|
||||||
"exports": {
|
|
||||||
"./package.json": "./package.json",
|
|
||||||
".": {
|
|
||||||
"types": "./index.d.ts",
|
|
||||||
"default": "./index.js"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"dependencies": {
|
|
||||||
"playwright": "1.56.0-alpha-2025-09-06",
|
|
||||||
"playwright-core": "1.56.0-alpha-2025-09-06"
|
|
||||||
},
|
|
||||||
"bin": {
|
|
||||||
"mcp-server-playwright": "cli.js"
|
|
||||||
},
|
},
|
||||||
|
"workspaces": [
|
||||||
|
"packages/*"
|
||||||
|
],
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@modelcontextprotocol/sdk": "^1.17.5",
|
"@modelcontextprotocol/sdk": "^1.25.2",
|
||||||
"@playwright/test": "1.56.0-alpha-2025-09-06",
|
"@playwright/test": "1.59.0-alpha-1769452054000",
|
||||||
"@types/node": "^24.3.0",
|
"@types/node": "^24.3.0"
|
||||||
"zod-to-json-schema": "^3.24.6"
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
1
packages/extension/.gitignore
vendored
Normal file
@@ -0,0 +1 @@
|
|||||||
|
dist/
|
||||||
@@ -45,4 +45,33 @@ Configure Playwright MCP server to connect to the browser using the extension by
|
|||||||
|
|
||||||
When the LLM interacts with the browser for the first time, it will load a page where you can select which browser tab the LLM will connect to. This allows you to control which specific page the AI assistant will interact with during the session.
|
When the LLM interacts with the browser for the first time, it will load a page where you can select which browser tab the LLM will connect to. This allows you to control which specific page the AI assistant will interact with during the session.
|
||||||
|
|
||||||
|
### Bypassing the Connection Approval Dialog
|
||||||
|
|
||||||
|
By default, you'll need to approve each connection when the MCP server tries to connect to your browser. To bypass this approval dialog and allow automatic connections, you can use an authentication token.
|
||||||
|
|
||||||
|
#### Using Your Unique Authentication Token
|
||||||
|
|
||||||
|
1. After installing the extension, click on the extension icon or navigate to the extension's status page
|
||||||
|
2. Copy the `PLAYWRIGHT_MCP_EXTENSION_TOKEN` value displayed in the extension UI
|
||||||
|
3. Add it to your MCP server configuration:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"mcpServers": {
|
||||||
|
"playwright-extension": {
|
||||||
|
"command": "npx",
|
||||||
|
"args": [
|
||||||
|
"@playwright/mcp@latest",
|
||||||
|
"--extension"
|
||||||
|
],
|
||||||
|
"env": {
|
||||||
|
"PLAYWRIGHT_MCP_EXTENSION_TOKEN": "your-token-here"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
This token is unique to your browser profile and provides secure authentication between the MCP server and the extension. Once configured, you won't need to manually approve connections each time.
|
||||||
|
|
||||||
|
|
||||||
|
Before Width: | Height: | Size: 6.2 KiB After Width: | Height: | Size: 6.2 KiB |
|
Before Width: | Height: | Size: 571 B After Width: | Height: | Size: 571 B |
|
Before Width: | Height: | Size: 1.2 KiB After Width: | Height: | Size: 1.2 KiB |
|
Before Width: | Height: | Size: 2.0 KiB After Width: | Height: | Size: 2.0 KiB |
@@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"manifest_version": 3,
|
"manifest_version": 3,
|
||||||
"name": "Playwright MCP Bridge",
|
"name": "Playwright MCP Bridge",
|
||||||
"version": "0.0.37",
|
"version": "0.0.61",
|
||||||
"description": "Share browser tabs with Playwright MCP server",
|
"description": "Share browser tabs with Playwright MCP server",
|
||||||
"key": "MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA9nMS2b0WCohjVHPGb8D9qAdkbIngDqoAjTeSccHJijgcONejge+OJxOQOMLu7b0ovt1c9BiEJa5JcpM+EHFVGL1vluBxK71zmBy1m2f9vZF3HG0LSCp7YRkum9rAIEthDwbkxx6XTvpmAY5rjFa/NON6b9Hlbo+8peUSkoOK7HTwYnnI36asZ9eUTiveIf+DMPLojW2UX33vDWG2UKvMVDewzclb4+uLxAYshY7Mx8we/b44xu+Anb/EBLKjOPk9Yh541xJ5Ozc8EiP/5yxOp9c/lRiYUHaRW+4r0HKZyFt0eZ52ti2iM4Nfk7jRXR7an3JPsUIf5deC/1cVM/+1ZQIDAQAB",
|
"key": "MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA9nMS2b0WCohjVHPGb8D9qAdkbIngDqoAjTeSccHJijgcONejge+OJxOQOMLu7b0ovt1c9BiEJa5JcpM+EHFVGL1vluBxK71zmBy1m2f9vZF3HG0LSCp7YRkum9rAIEthDwbkxx6XTvpmAY5rjFa/NON6b9Hlbo+8peUSkoOK7HTwYnnI36asZ9eUTiveIf+DMPLojW2UX33vDWG2UKvMVDewzclb4+uLxAYshY7Mx8we/b44xu+Anb/EBLKjOPk9Yh541xJ5Ozc8EiP/5yxOp9c/lRiYUHaRW+4r0HKZyFt0eZ52ti2iM4Nfk7jRXR7an3JPsUIf5deC/1cVM/+1ZQIDAQAB",
|
||||||
"permissions": [
|
"permissions": [
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@playwright/mcp-extension",
|
"name": "@playwright/mcp-extension",
|
||||||
"version": "0.0.37",
|
"version": "0.0.61",
|
||||||
"description": "Playwright MCP Browser Extension",
|
"description": "Playwright MCP Browser Extension",
|
||||||
"private": true,
|
"private": true,
|
||||||
"repository": {
|
"repository": {
|
||||||
@@ -19,6 +19,7 @@
|
|||||||
"build": "tsc --project . && tsc --project tsconfig.ui.json && vite build && vite build --config vite.sw.config.mts",
|
"build": "tsc --project . && tsc --project tsconfig.ui.json && vite build && vite build --config vite.sw.config.mts",
|
||||||
"watch": "tsc --watch --project . & tsc --watch --project tsconfig.ui.json & vite build --watch & vite build --watch --config vite.sw.config.mts",
|
"watch": "tsc --watch --project . & tsc --watch --project tsconfig.ui.json & vite build --watch & vite build --watch --config vite.sw.config.mts",
|
||||||
"test": "playwright test",
|
"test": "playwright test",
|
||||||
|
"lint": "tsc --project .",
|
||||||
"clean": "rm -rf dist"
|
"clean": "rm -rf dist"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
@@ -29,7 +30,7 @@
|
|||||||
"react": "^18.2.0",
|
"react": "^18.2.0",
|
||||||
"react-dom": "^18.2.0",
|
"react-dom": "^18.2.0",
|
||||||
"typescript": "^5.8.2",
|
"typescript": "^5.8.2",
|
||||||
"vite": "^5.0.0",
|
"vite": "^5.4.21",
|
||||||
"vite-plugin-static-copy": "^3.1.1"
|
"vite-plugin-static-copy": "^3.1.1"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -16,7 +16,7 @@
|
|||||||
|
|
||||||
import { defineConfig } from '@playwright/test';
|
import { defineConfig } from '@playwright/test';
|
||||||
|
|
||||||
import type { TestOptions } from '../tests/fixtures';
|
import type { TestOptions } from '../playwright-mcp/tests/fixtures';
|
||||||
|
|
||||||
export default defineConfig<TestOptions>({
|
export default defineConfig<TestOptions>({
|
||||||
testDir: './tests',
|
testDir: './tests',
|
||||||
142
packages/extension/src/ui/authToken.css
Normal file
@@ -0,0 +1,142 @@
|
|||||||
|
/*
|
||||||
|
Copyright (c) Microsoft Corporation.
|
||||||
|
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
you may not use this file except in compliance with the License.
|
||||||
|
You may obtain a copy of the License at
|
||||||
|
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
See the License for the specific language governing permissions and
|
||||||
|
limitations under the License.
|
||||||
|
*/
|
||||||
|
|
||||||
|
.auth-token-section {
|
||||||
|
margin: 16px 0;
|
||||||
|
padding: 16px;
|
||||||
|
background-color: #f6f8fa;
|
||||||
|
border-radius: 6px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.auth-token-description {
|
||||||
|
font-size: 12px;
|
||||||
|
color: #656d76;
|
||||||
|
margin-bottom: 12px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.auth-token-container {
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
gap: 8px;
|
||||||
|
background-color: #ffffff;
|
||||||
|
padding: 8px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.auth-token-code {
|
||||||
|
font-family: 'SFMono-Regular', Consolas, 'Liberation Mono', Menlo, monospace;
|
||||||
|
font-size: 12px;
|
||||||
|
color: #1f2328;
|
||||||
|
border: none;
|
||||||
|
flex: 1;
|
||||||
|
padding: 0;
|
||||||
|
word-break: break-all;
|
||||||
|
}
|
||||||
|
|
||||||
|
.auth-token-refresh {
|
||||||
|
flex: none;
|
||||||
|
height: 24px;
|
||||||
|
width: 24px;
|
||||||
|
border: none;
|
||||||
|
outline: none;
|
||||||
|
color: var(--color-fg-muted);
|
||||||
|
background: transparent;
|
||||||
|
padding: 4px;
|
||||||
|
cursor: pointer;
|
||||||
|
display: inline-flex;
|
||||||
|
align-items: center;
|
||||||
|
justify-content: center;
|
||||||
|
border-radius: 4px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.auth-token-refresh svg {
|
||||||
|
margin: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.auth-token-refresh:not(:disabled):hover {
|
||||||
|
background-color: var(--color-btn-selected-bg);
|
||||||
|
}
|
||||||
|
|
||||||
|
.auth-token-example-section {
|
||||||
|
margin-top: 16px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.auth-token-example-toggle {
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
gap: 8px;
|
||||||
|
background: none;
|
||||||
|
border: none;
|
||||||
|
padding: 8px 0;
|
||||||
|
font-size: 12px;
|
||||||
|
color: #656d76;
|
||||||
|
cursor: pointer;
|
||||||
|
outline: none;
|
||||||
|
text-align: left;
|
||||||
|
width: 100%;
|
||||||
|
}
|
||||||
|
|
||||||
|
.auth-token-example-toggle:hover {
|
||||||
|
color: #1f2328;
|
||||||
|
}
|
||||||
|
|
||||||
|
.auth-token-chevron {
|
||||||
|
display: inline-flex;
|
||||||
|
align-items: center;
|
||||||
|
justify-content: center;
|
||||||
|
transform: rotate(-90deg);
|
||||||
|
flex-shrink: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.auth-token-chevron.expanded {
|
||||||
|
transform: rotate(0deg);
|
||||||
|
}
|
||||||
|
|
||||||
|
.auth-token-chevron svg {
|
||||||
|
width: 12px;
|
||||||
|
height: 12px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.auth-token-chevron .octicon {
|
||||||
|
margin: 0px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.auth-token-example-content {
|
||||||
|
margin-top: 12px;
|
||||||
|
padding: 12px 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.auth-token-example-description {
|
||||||
|
font-size: 12px;
|
||||||
|
color: #656d76;
|
||||||
|
margin-bottom: 12px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.auth-token-example-config {
|
||||||
|
display: flex;
|
||||||
|
align-items: flex-start;
|
||||||
|
gap: 8px;
|
||||||
|
background-color: #ffffff;
|
||||||
|
padding: 12px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.auth-token-example-code {
|
||||||
|
font-family: 'SFMono-Regular', Consolas, 'Liberation Mono', Menlo, monospace;
|
||||||
|
font-size: 11px;
|
||||||
|
color: #1f2328;
|
||||||
|
white-space: pre;
|
||||||
|
flex: 1;
|
||||||
|
line-height: 1.4;
|
||||||
|
}
|
||||||
118
packages/extension/src/ui/authToken.tsx
Normal file
@@ -0,0 +1,118 @@
|
|||||||
|
/**
|
||||||
|
* Copyright (c) Microsoft Corporation.
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import React, { useCallback, useState } from 'react';
|
||||||
|
import { CopyToClipboard } from './copyToClipboard';
|
||||||
|
import * as icons from './icons';
|
||||||
|
import './authToken.css';
|
||||||
|
|
||||||
|
export const AuthTokenSection: React.FC<{}> = ({}) => {
|
||||||
|
const [authToken, setAuthToken] = useState<string>(getOrCreateAuthToken);
|
||||||
|
const [isExampleExpanded, setIsExampleExpanded] = useState<boolean>(false);
|
||||||
|
|
||||||
|
const onRegenerateToken = useCallback(() => {
|
||||||
|
const newToken = generateAuthToken();
|
||||||
|
localStorage.setItem('auth-token', newToken);
|
||||||
|
setAuthToken(newToken);
|
||||||
|
}, []);
|
||||||
|
|
||||||
|
const toggleExample = useCallback(() => {
|
||||||
|
setIsExampleExpanded(!isExampleExpanded);
|
||||||
|
}, [isExampleExpanded]);
|
||||||
|
|
||||||
|
return (
|
||||||
|
<div className='auth-token-section'>
|
||||||
|
<div className='auth-token-description'>
|
||||||
|
Set this environment variable to bypass the connection dialog:
|
||||||
|
</div>
|
||||||
|
<div className='auth-token-container'>
|
||||||
|
<code className='auth-token-code'>{authTokenCode(authToken)}</code>
|
||||||
|
<button className='auth-token-refresh' title='Generate new token' aria-label='Generate new token'onClick={onRegenerateToken}>{icons.refresh()}</button>
|
||||||
|
<CopyToClipboard value={authTokenCode(authToken)} />
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div className='auth-token-example-section'>
|
||||||
|
<button
|
||||||
|
className='auth-token-example-toggle'
|
||||||
|
onClick={toggleExample}
|
||||||
|
aria-expanded={isExampleExpanded}
|
||||||
|
title={isExampleExpanded ? 'Hide example config' : 'Show example config'}
|
||||||
|
>
|
||||||
|
<span className={`auth-token-chevron ${isExampleExpanded ? 'expanded' : ''}`}>
|
||||||
|
{icons.chevronDown()}
|
||||||
|
</span>
|
||||||
|
Example MCP server configuration
|
||||||
|
</button>
|
||||||
|
|
||||||
|
{isExampleExpanded && (
|
||||||
|
<div className='auth-token-example-content'>
|
||||||
|
<div className='auth-token-example-description'>
|
||||||
|
Add this configuration to your MCP client (e.g., VS Code) to connect to the Playwright MCP Bridge:
|
||||||
|
</div>
|
||||||
|
<div className='auth-token-example-config'>
|
||||||
|
<code className='auth-token-example-code'>{exampleConfig(authToken)}</code>
|
||||||
|
<CopyToClipboard value={exampleConfig(authToken)} />
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
)}
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
};
|
||||||
|
|
||||||
|
function authTokenCode(authToken: string) {
|
||||||
|
return `PLAYWRIGHT_MCP_EXTENSION_TOKEN=${authToken}`;
|
||||||
|
}
|
||||||
|
|
||||||
|
function exampleConfig(authToken: string) {
|
||||||
|
return `{
|
||||||
|
"mcpServers": {
|
||||||
|
"playwright": {
|
||||||
|
"command": "npx",
|
||||||
|
"args": ["@playwright/mcp@latest", "--extension"],
|
||||||
|
"env": {
|
||||||
|
"PLAYWRIGHT_MCP_EXTENSION_TOKEN":
|
||||||
|
"${authToken}"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}`;
|
||||||
|
}
|
||||||
|
|
||||||
|
function generateAuthToken(): string {
|
||||||
|
// Generate a cryptographically secure random token
|
||||||
|
const array = new Uint8Array(32);
|
||||||
|
crypto.getRandomValues(array);
|
||||||
|
// Convert to base64 and make it URL-safe
|
||||||
|
return btoa(String.fromCharCode.apply(null, Array.from(array)))
|
||||||
|
.replace(/[+/=]/g, match => {
|
||||||
|
switch (match) {
|
||||||
|
case '+': return '-';
|
||||||
|
case '/': return '_';
|
||||||
|
case '=': return '';
|
||||||
|
default: return match;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
export const getOrCreateAuthToken = (): string => {
|
||||||
|
let token = localStorage.getItem('auth-token');
|
||||||
|
if (!token) {
|
||||||
|
token = generateAuthToken();
|
||||||
|
localStorage.setItem('auth-token', token);
|
||||||
|
}
|
||||||
|
return token;
|
||||||
|
}
|
||||||
891
packages/extension/src/ui/colors.css
Normal file
@@ -0,0 +1,891 @@
|
|||||||
|
/* The MIT License (MIT)
|
||||||
|
|
||||||
|
Copyright (c) 2021 GitHub Inc.
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE. */
|
||||||
|
|
||||||
|
:root {
|
||||||
|
--color-canvas-default-transparent: rgba(255,255,255,0);
|
||||||
|
--color-marketing-icon-primary: #218bff;
|
||||||
|
--color-marketing-icon-secondary: #54aeff;
|
||||||
|
--color-diff-blob-addition-num-text: #24292f;
|
||||||
|
--color-diff-blob-addition-fg: #24292f;
|
||||||
|
--color-diff-blob-addition-num-bg: #CCFFD8;
|
||||||
|
--color-diff-blob-addition-line-bg: #E6FFEC;
|
||||||
|
--color-diff-blob-addition-word-bg: #ABF2BC;
|
||||||
|
--color-diff-blob-deletion-num-text: #24292f;
|
||||||
|
--color-diff-blob-deletion-fg: #24292f;
|
||||||
|
--color-diff-blob-deletion-num-bg: #FFD7D5;
|
||||||
|
--color-diff-blob-deletion-line-bg: #FFEBE9;
|
||||||
|
--color-diff-blob-deletion-word-bg: rgba(255,129,130,0.4);
|
||||||
|
--color-diff-blob-hunk-num-bg: rgba(84,174,255,0.4);
|
||||||
|
--color-diff-blob-expander-icon: #57606a;
|
||||||
|
--color-diff-blob-selected-line-highlight-mix-blend-mode: multiply;
|
||||||
|
--color-diffstat-deletion-border: rgba(27,31,36,0.15);
|
||||||
|
--color-diffstat-addition-border: rgba(27,31,36,0.15);
|
||||||
|
--color-diffstat-addition-bg: #2da44e;
|
||||||
|
--color-search-keyword-hl: #fff8c5;
|
||||||
|
--color-prettylights-syntax-comment: #6e7781;
|
||||||
|
--color-prettylights-syntax-constant: #0550ae;
|
||||||
|
--color-prettylights-syntax-entity: #8250df;
|
||||||
|
--color-prettylights-syntax-storage-modifier-import: #24292f;
|
||||||
|
--color-prettylights-syntax-entity-tag: #116329;
|
||||||
|
--color-prettylights-syntax-keyword: #cf222e;
|
||||||
|
--color-prettylights-syntax-string: #0a3069;
|
||||||
|
--color-prettylights-syntax-variable: #953800;
|
||||||
|
--color-prettylights-syntax-brackethighlighter-unmatched: #82071e;
|
||||||
|
--color-prettylights-syntax-invalid-illegal-text: #f6f8fa;
|
||||||
|
--color-prettylights-syntax-invalid-illegal-bg: #82071e;
|
||||||
|
--color-prettylights-syntax-carriage-return-text: #f6f8fa;
|
||||||
|
--color-prettylights-syntax-carriage-return-bg: #cf222e;
|
||||||
|
--color-prettylights-syntax-string-regexp: #116329;
|
||||||
|
--color-prettylights-syntax-markup-list: #3b2300;
|
||||||
|
--color-prettylights-syntax-markup-heading: #0550ae;
|
||||||
|
--color-prettylights-syntax-markup-italic: #24292f;
|
||||||
|
--color-prettylights-syntax-markup-bold: #24292f;
|
||||||
|
--color-prettylights-syntax-markup-deleted-text: #82071e;
|
||||||
|
--color-prettylights-syntax-markup-deleted-bg: #FFEBE9;
|
||||||
|
--color-prettylights-syntax-markup-inserted-text: #116329;
|
||||||
|
--color-prettylights-syntax-markup-inserted-bg: #dafbe1;
|
||||||
|
--color-prettylights-syntax-markup-changed-text: #953800;
|
||||||
|
--color-prettylights-syntax-markup-changed-bg: #ffd8b5;
|
||||||
|
--color-prettylights-syntax-markup-ignored-text: #eaeef2;
|
||||||
|
--color-prettylights-syntax-markup-ignored-bg: #0550ae;
|
||||||
|
--color-prettylights-syntax-meta-diff-range: #8250df;
|
||||||
|
--color-prettylights-syntax-brackethighlighter-angle: #57606a;
|
||||||
|
--color-prettylights-syntax-sublimelinter-gutter-mark: #8c959f;
|
||||||
|
--color-prettylights-syntax-constant-other-reference-link: #0a3069;
|
||||||
|
--color-codemirror-text: #24292f;
|
||||||
|
--color-codemirror-bg: #ffffff;
|
||||||
|
--color-codemirror-gutters-bg: #ffffff;
|
||||||
|
--color-codemirror-guttermarker-text: #ffffff;
|
||||||
|
--color-codemirror-guttermarker-subtle-text: #6e7781;
|
||||||
|
--color-codemirror-linenumber-text: #57606a;
|
||||||
|
--color-codemirror-cursor: #24292f;
|
||||||
|
--color-codemirror-selection-bg: rgba(84,174,255,0.4);
|
||||||
|
--color-codemirror-activeline-bg: rgba(234,238,242,0.5);
|
||||||
|
--color-codemirror-matchingbracket-text: #24292f;
|
||||||
|
--color-codemirror-lines-bg: #ffffff;
|
||||||
|
--color-codemirror-syntax-comment: #24292f;
|
||||||
|
--color-codemirror-syntax-constant: #0550ae;
|
||||||
|
--color-codemirror-syntax-entity: #8250df;
|
||||||
|
--color-codemirror-syntax-keyword: #cf222e;
|
||||||
|
--color-codemirror-syntax-storage: #cf222e;
|
||||||
|
--color-codemirror-syntax-string: #0a3069;
|
||||||
|
--color-codemirror-syntax-support: #0550ae;
|
||||||
|
--color-codemirror-syntax-variable: #953800;
|
||||||
|
--color-checks-bg: #24292f;
|
||||||
|
--color-checks-run-border-width: 0px;
|
||||||
|
--color-checks-container-border-width: 0px;
|
||||||
|
--color-checks-text-primary: #f6f8fa;
|
||||||
|
--color-checks-text-secondary: #8c959f;
|
||||||
|
--color-checks-text-link: #54aeff;
|
||||||
|
--color-checks-btn-icon: #afb8c1;
|
||||||
|
--color-checks-btn-hover-icon: #f6f8fa;
|
||||||
|
--color-checks-btn-hover-bg: rgba(255,255,255,0.125);
|
||||||
|
--color-checks-input-text: #eaeef2;
|
||||||
|
--color-checks-input-placeholder-text: #8c959f;
|
||||||
|
--color-checks-input-focus-text: #8c959f;
|
||||||
|
--color-checks-input-bg: #32383f;
|
||||||
|
--color-checks-input-shadow: none;
|
||||||
|
--color-checks-donut-error: #fa4549;
|
||||||
|
--color-checks-donut-pending: #bf8700;
|
||||||
|
--color-checks-donut-success: #2da44e;
|
||||||
|
--color-checks-donut-neutral: #afb8c1;
|
||||||
|
--color-checks-dropdown-text: #afb8c1;
|
||||||
|
--color-checks-dropdown-bg: #32383f;
|
||||||
|
--color-checks-dropdown-border: #424a53;
|
||||||
|
--color-checks-dropdown-shadow: rgba(27,31,36,0.3);
|
||||||
|
--color-checks-dropdown-hover-text: #f6f8fa;
|
||||||
|
--color-checks-dropdown-hover-bg: #424a53;
|
||||||
|
--color-checks-dropdown-btn-hover-text: #f6f8fa;
|
||||||
|
--color-checks-dropdown-btn-hover-bg: #32383f;
|
||||||
|
--color-checks-scrollbar-thumb-bg: #57606a;
|
||||||
|
--color-checks-header-label-text: #d0d7de;
|
||||||
|
--color-checks-header-label-open-text: #f6f8fa;
|
||||||
|
--color-checks-header-border: #32383f;
|
||||||
|
--color-checks-header-icon: #8c959f;
|
||||||
|
--color-checks-line-text: #d0d7de;
|
||||||
|
--color-checks-line-num-text: rgba(140,149,159,0.75);
|
||||||
|
--color-checks-line-timestamp-text: #8c959f;
|
||||||
|
--color-checks-line-hover-bg: #32383f;
|
||||||
|
--color-checks-line-selected-bg: rgba(33,139,255,0.15);
|
||||||
|
--color-checks-line-selected-num-text: #54aeff;
|
||||||
|
--color-checks-line-dt-fm-text: #24292f;
|
||||||
|
--color-checks-line-dt-fm-bg: #9a6700;
|
||||||
|
--color-checks-gate-bg: rgba(125,78,0,0.15);
|
||||||
|
--color-checks-gate-text: #d0d7de;
|
||||||
|
--color-checks-gate-waiting-text: #afb8c1;
|
||||||
|
--color-checks-step-header-open-bg: #32383f;
|
||||||
|
--color-checks-step-error-text: #ff8182;
|
||||||
|
--color-checks-step-warning-text: #d4a72c;
|
||||||
|
--color-checks-logline-text: #8c959f;
|
||||||
|
--color-checks-logline-num-text: rgba(140,149,159,0.75);
|
||||||
|
--color-checks-logline-debug-text: #c297ff;
|
||||||
|
--color-checks-logline-error-text: #d0d7de;
|
||||||
|
--color-checks-logline-error-num-text: #ff8182;
|
||||||
|
--color-checks-logline-error-bg: rgba(164,14,38,0.15);
|
||||||
|
--color-checks-logline-warning-text: #d0d7de;
|
||||||
|
--color-checks-logline-warning-num-text: #d4a72c;
|
||||||
|
--color-checks-logline-warning-bg: rgba(125,78,0,0.15);
|
||||||
|
--color-checks-logline-command-text: #54aeff;
|
||||||
|
--color-checks-logline-section-text: #4ac26b;
|
||||||
|
--color-checks-ansi-black: #24292f;
|
||||||
|
--color-checks-ansi-black-bright: #32383f;
|
||||||
|
--color-checks-ansi-white: #d0d7de;
|
||||||
|
--color-checks-ansi-white-bright: #d0d7de;
|
||||||
|
--color-checks-ansi-gray: #8c959f;
|
||||||
|
--color-checks-ansi-red: #ff8182;
|
||||||
|
--color-checks-ansi-red-bright: #ffaba8;
|
||||||
|
--color-checks-ansi-green: #4ac26b;
|
||||||
|
--color-checks-ansi-green-bright: #6fdd8b;
|
||||||
|
--color-checks-ansi-yellow: #d4a72c;
|
||||||
|
--color-checks-ansi-yellow-bright: #eac54f;
|
||||||
|
--color-checks-ansi-blue: #54aeff;
|
||||||
|
--color-checks-ansi-blue-bright: #80ccff;
|
||||||
|
--color-checks-ansi-magenta: #c297ff;
|
||||||
|
--color-checks-ansi-magenta-bright: #d8b9ff;
|
||||||
|
--color-checks-ansi-cyan: #76e3ea;
|
||||||
|
--color-checks-ansi-cyan-bright: #b3f0ff;
|
||||||
|
--color-project-header-bg: #24292f;
|
||||||
|
--color-project-sidebar-bg: #ffffff;
|
||||||
|
--color-project-gradient-in: #ffffff;
|
||||||
|
--color-project-gradient-out: rgba(255,255,255,0);
|
||||||
|
--color-mktg-success: rgba(36,146,67,1);
|
||||||
|
--color-mktg-info: rgba(19,119,234,1);
|
||||||
|
--color-mktg-bg-shade-gradient-top: rgba(27,31,36,0.065);
|
||||||
|
--color-mktg-bg-shade-gradient-bottom: rgba(27,31,36,0);
|
||||||
|
--color-mktg-btn-bg-top: hsla(228,82%,66%,1);
|
||||||
|
--color-mktg-btn-bg-bottom: #4969ed;
|
||||||
|
--color-mktg-btn-bg-overlay-top: hsla(228,74%,59%,1);
|
||||||
|
--color-mktg-btn-bg-overlay-bottom: #3355e0;
|
||||||
|
--color-mktg-btn-text: #ffffff;
|
||||||
|
--color-mktg-btn-primary-bg-top: hsla(137,56%,46%,1);
|
||||||
|
--color-mktg-btn-primary-bg-bottom: #2ea44f;
|
||||||
|
--color-mktg-btn-primary-bg-overlay-top: hsla(134,60%,38%,1);
|
||||||
|
--color-mktg-btn-primary-bg-overlay-bottom: #22863a;
|
||||||
|
--color-mktg-btn-primary-text: #ffffff;
|
||||||
|
--color-mktg-btn-enterprise-bg-top: hsla(249,100%,72%,1);
|
||||||
|
--color-mktg-btn-enterprise-bg-bottom: #6f57ff;
|
||||||
|
--color-mktg-btn-enterprise-bg-overlay-top: hsla(248,65%,63%,1);
|
||||||
|
--color-mktg-btn-enterprise-bg-overlay-bottom: #614eda;
|
||||||
|
--color-mktg-btn-enterprise-text: #ffffff;
|
||||||
|
--color-mktg-btn-outline-text: #4969ed;
|
||||||
|
--color-mktg-btn-outline-border: rgba(73,105,237,0.3);
|
||||||
|
--color-mktg-btn-outline-hover-text: #3355e0;
|
||||||
|
--color-mktg-btn-outline-hover-border: rgba(51,85,224,0.5);
|
||||||
|
--color-mktg-btn-outline-focus-border: #4969ed;
|
||||||
|
--color-mktg-btn-outline-focus-border-inset: rgba(73,105,237,0.5);
|
||||||
|
--color-mktg-btn-dark-text: #ffffff;
|
||||||
|
--color-mktg-btn-dark-border: rgba(255,255,255,0.3);
|
||||||
|
--color-mktg-btn-dark-hover-text: #ffffff;
|
||||||
|
--color-mktg-btn-dark-hover-border: rgba(255,255,255,0.5);
|
||||||
|
--color-mktg-btn-dark-focus-border: #ffffff;
|
||||||
|
--color-mktg-btn-dark-focus-border-inset: rgba(255,255,255,0.5);
|
||||||
|
--color-avatar-bg: #ffffff;
|
||||||
|
--color-avatar-border: rgba(27,31,36,0.15);
|
||||||
|
--color-avatar-stack-fade: #afb8c1;
|
||||||
|
--color-avatar-stack-fade-more: #d0d7de;
|
||||||
|
--color-avatar-child-shadow: -2px -2px 0 rgba(255,255,255,0.8);
|
||||||
|
--color-topic-tag-border: rgba(0,0,0,0);
|
||||||
|
--color-select-menu-backdrop-border: rgba(0,0,0,0);
|
||||||
|
--color-select-menu-tap-highlight: rgba(175,184,193,0.5);
|
||||||
|
--color-select-menu-tap-focus-bg: #b6e3ff;
|
||||||
|
--color-overlay-shadow: 0 1px 3px rgba(27,31,36,0.12), 0 8px 24px rgba(66,74,83,0.12);
|
||||||
|
--color-header-text: rgba(255,255,255,0.7);
|
||||||
|
--color-header-bg: #24292f;
|
||||||
|
--color-header-logo: #ffffff;
|
||||||
|
--color-header-search-bg: #24292f;
|
||||||
|
--color-header-search-border: #57606a;
|
||||||
|
--color-sidenav-selected-bg: #ffffff;
|
||||||
|
--color-menu-bg-active: rgba(0,0,0,0);
|
||||||
|
--color-control-transparent-bg-hover: #818b981a;
|
||||||
|
--color-input-disabled-bg: rgba(175,184,193,0.2);
|
||||||
|
--color-timeline-badge-bg: #eaeef2;
|
||||||
|
--color-ansi-black: #24292f;
|
||||||
|
--color-ansi-black-bright: #57606a;
|
||||||
|
--color-ansi-white: #6e7781;
|
||||||
|
--color-ansi-white-bright: #8c959f;
|
||||||
|
--color-ansi-gray: #6e7781;
|
||||||
|
--color-ansi-red: #cf222e;
|
||||||
|
--color-ansi-red-bright: #a40e26;
|
||||||
|
--color-ansi-green: #116329;
|
||||||
|
--color-ansi-green-bright: #1a7f37;
|
||||||
|
--color-ansi-yellow: #4d2d00;
|
||||||
|
--color-ansi-yellow-bright: #633c01;
|
||||||
|
--color-ansi-blue: #0969da;
|
||||||
|
--color-ansi-blue-bright: #218bff;
|
||||||
|
--color-ansi-magenta: #8250df;
|
||||||
|
--color-ansi-magenta-bright: #a475f9;
|
||||||
|
--color-ansi-cyan: #1b7c83;
|
||||||
|
--color-ansi-cyan-bright: #3192aa;
|
||||||
|
--color-btn-text: #24292f;
|
||||||
|
--color-btn-bg: #f6f8fa;
|
||||||
|
--color-btn-border: rgba(27,31,36,0.15);
|
||||||
|
--color-btn-shadow: 0 1px 0 rgba(27,31,36,0.04);
|
||||||
|
--color-btn-inset-shadow: inset 0 1px 0 rgba(255,255,255,0.25);
|
||||||
|
--color-btn-hover-bg: #f3f4f6;
|
||||||
|
--color-btn-hover-border: rgba(27,31,36,0.15);
|
||||||
|
--color-btn-active-bg: hsla(220,14%,93%,1);
|
||||||
|
--color-btn-active-border: rgba(27,31,36,0.15);
|
||||||
|
--color-btn-selected-bg: hsla(220,14%,94%,1);
|
||||||
|
--color-btn-focus-bg: #f6f8fa;
|
||||||
|
--color-btn-focus-border: rgba(27,31,36,0.15);
|
||||||
|
--color-btn-focus-shadow: 0 0 0 3px rgba(9,105,218,0.3);
|
||||||
|
--color-btn-shadow-active: inset 0 0.15em 0.3em rgba(27,31,36,0.15);
|
||||||
|
--color-btn-shadow-input-focus: 0 0 0 0.2em rgba(9,105,218,0.3);
|
||||||
|
--color-btn-counter-bg: rgba(27,31,36,0.08);
|
||||||
|
--color-btn-primary-text: #ffffff;
|
||||||
|
--color-btn-primary-bg: #2da44e;
|
||||||
|
--color-btn-primary-border: rgba(27,31,36,0.15);
|
||||||
|
--color-btn-primary-shadow: 0 1px 0 rgba(27,31,36,0.1);
|
||||||
|
--color-btn-primary-inset-shadow: inset 0 1px 0 rgba(255,255,255,0.03);
|
||||||
|
--color-btn-primary-hover-bg: #2c974b;
|
||||||
|
--color-btn-primary-hover-border: rgba(27,31,36,0.15);
|
||||||
|
--color-btn-primary-selected-bg: hsla(137,55%,36%,1);
|
||||||
|
--color-btn-primary-selected-shadow: inset 0 1px 0 rgba(0,45,17,0.2);
|
||||||
|
--color-btn-primary-disabled-text: rgba(255,255,255,0.8);
|
||||||
|
--color-btn-primary-disabled-bg: #94d3a2;
|
||||||
|
--color-btn-primary-disabled-border: rgba(27,31,36,0.15);
|
||||||
|
--color-btn-primary-focus-bg: #2da44e;
|
||||||
|
--color-btn-primary-focus-border: rgba(27,31,36,0.15);
|
||||||
|
--color-btn-primary-focus-shadow: 0 0 0 3px rgba(45,164,78,0.4);
|
||||||
|
--color-btn-primary-icon: rgba(255,255,255,0.8);
|
||||||
|
--color-btn-primary-counter-bg: rgba(255,255,255,0.2);
|
||||||
|
--color-btn-outline-text: #0969da;
|
||||||
|
--color-btn-outline-hover-text: #ffffff;
|
||||||
|
--color-btn-outline-hover-bg: #0969da;
|
||||||
|
--color-btn-outline-hover-border: rgba(27,31,36,0.15);
|
||||||
|
--color-btn-outline-hover-shadow: 0 1px 0 rgba(27,31,36,0.1);
|
||||||
|
--color-btn-outline-hover-inset-shadow: inset 0 1px 0 rgba(255,255,255,0.03);
|
||||||
|
--color-btn-outline-hover-counter-bg: rgba(255,255,255,0.2);
|
||||||
|
--color-btn-outline-selected-text: #ffffff;
|
||||||
|
--color-btn-outline-selected-bg: hsla(212,92%,42%,1);
|
||||||
|
--color-btn-outline-selected-border: rgba(27,31,36,0.15);
|
||||||
|
--color-btn-outline-selected-shadow: inset 0 1px 0 rgba(0,33,85,0.2);
|
||||||
|
--color-btn-outline-disabled-text: rgba(9,105,218,0.5);
|
||||||
|
--color-btn-outline-disabled-bg: #f6f8fa;
|
||||||
|
--color-btn-outline-disabled-counter-bg: rgba(9,105,218,0.05);
|
||||||
|
--color-btn-outline-focus-border: rgba(27,31,36,0.15);
|
||||||
|
--color-btn-outline-focus-shadow: 0 0 0 3px rgba(5,80,174,0.4);
|
||||||
|
--color-btn-outline-counter-bg: rgba(9,105,218,0.1);
|
||||||
|
--color-btn-danger-text: #cf222e;
|
||||||
|
--color-btn-danger-hover-text: #ffffff;
|
||||||
|
--color-btn-danger-hover-bg: #a40e26;
|
||||||
|
--color-btn-danger-hover-border: rgba(27,31,36,0.15);
|
||||||
|
--color-btn-danger-hover-shadow: 0 1px 0 rgba(27,31,36,0.1);
|
||||||
|
--color-btn-danger-hover-inset-shadow: inset 0 1px 0 rgba(255,255,255,0.03);
|
||||||
|
--color-btn-danger-hover-counter-bg: rgba(255,255,255,0.2);
|
||||||
|
--color-btn-danger-selected-text: #ffffff;
|
||||||
|
--color-btn-danger-selected-bg: hsla(356,72%,44%,1);
|
||||||
|
--color-btn-danger-selected-border: rgba(27,31,36,0.15);
|
||||||
|
--color-btn-danger-selected-shadow: inset 0 1px 0 rgba(76,0,20,0.2);
|
||||||
|
--color-btn-danger-disabled-text: rgba(207,34,46,0.5);
|
||||||
|
--color-btn-danger-disabled-bg: #f6f8fa;
|
||||||
|
--color-btn-danger-disabled-counter-bg: rgba(207,34,46,0.05);
|
||||||
|
--color-btn-danger-focus-border: rgba(27,31,36,0.15);
|
||||||
|
--color-btn-danger-focus-shadow: 0 0 0 3px rgba(164,14,38,0.4);
|
||||||
|
--color-btn-danger-counter-bg: rgba(207,34,46,0.1);
|
||||||
|
--color-btn-danger-icon: #cf222e;
|
||||||
|
--color-btn-danger-hover-icon: #ffffff;
|
||||||
|
--color-underlinenav-icon: #6e7781;
|
||||||
|
--color-underlinenav-border-hover: rgba(175,184,193,0.2);
|
||||||
|
--color-fg-default: #24292f;
|
||||||
|
--color-fg-muted: #57606a;
|
||||||
|
--color-fg-subtle: #6e7781;
|
||||||
|
--color-fg-on-emphasis: #ffffff;
|
||||||
|
--color-canvas-default: #ffffff;
|
||||||
|
--color-canvas-overlay: #ffffff;
|
||||||
|
--color-canvas-inset: #f6f8fa;
|
||||||
|
--color-canvas-subtle: #f6f8fa;
|
||||||
|
--color-border-default: #d0d7de;
|
||||||
|
--color-border-muted: hsla(210,18%,87%,1);
|
||||||
|
--color-border-subtle: rgba(27,31,36,0.15);
|
||||||
|
--color-shadow-small: 0 1px 0 rgba(27,31,36,0.04);
|
||||||
|
--color-shadow-medium: 0 3px 6px rgba(140,149,159,0.15);
|
||||||
|
--color-shadow-large: 0 8px 24px rgba(140,149,159,0.2);
|
||||||
|
--color-shadow-extra-large: 0 12px 28px rgba(140,149,159,0.3);
|
||||||
|
--color-neutral-emphasis-plus: #24292f;
|
||||||
|
--color-neutral-emphasis: #6e7781;
|
||||||
|
--color-neutral-muted: rgba(175,184,193,0.2);
|
||||||
|
--color-neutral-subtle: rgba(234,238,242,0.5);
|
||||||
|
--color-accent-fg: #0969da;
|
||||||
|
--color-accent-emphasis: #0969da;
|
||||||
|
--color-accent-muted: rgba(84,174,255,0.4);
|
||||||
|
--color-accent-subtle: #ddf4ff;
|
||||||
|
--color-success-fg: #1a7f37;
|
||||||
|
--color-success-emphasis: #2da44e;
|
||||||
|
--color-success-muted: rgba(74,194,107,0.4);
|
||||||
|
--color-success-subtle: #dafbe1;
|
||||||
|
--color-attention-fg: #9a6700;
|
||||||
|
--color-attention-emphasis: #bf8700;
|
||||||
|
--color-attention-muted: rgba(212,167,44,0.4);
|
||||||
|
--color-attention-subtle: #fff8c5;
|
||||||
|
--color-severe-fg: #bc4c00;
|
||||||
|
--color-severe-emphasis: #bc4c00;
|
||||||
|
--color-severe-muted: rgba(251,143,68,0.4);
|
||||||
|
--color-severe-subtle: #fff1e5;
|
||||||
|
--color-danger-fg: #cf222e;
|
||||||
|
--color-danger-emphasis: #cf222e;
|
||||||
|
--color-danger-muted: rgba(255,129,130,0.4);
|
||||||
|
--color-danger-subtle: #FFEBE9;
|
||||||
|
--color-done-fg: #8250df;
|
||||||
|
--color-done-emphasis: #8250df;
|
||||||
|
--color-done-muted: rgba(194,151,255,0.4);
|
||||||
|
--color-done-subtle: #fbefff;
|
||||||
|
--color-sponsors-fg: #bf3989;
|
||||||
|
--color-sponsors-emphasis: #bf3989;
|
||||||
|
--color-sponsors-muted: rgba(255,128,200,0.4);
|
||||||
|
--color-sponsors-subtle: #ffeff7;
|
||||||
|
--color-primer-canvas-backdrop: rgba(27,31,36,0.5);
|
||||||
|
--color-primer-canvas-sticky: rgba(255,255,255,0.95);
|
||||||
|
--color-primer-border-active: #FD8C73;
|
||||||
|
--color-primer-border-contrast: rgba(27,31,36,0.1);
|
||||||
|
--color-primer-shadow-highlight: inset 0 1px 0 rgba(255,255,255,0.25);
|
||||||
|
--color-primer-shadow-inset: inset 0 1px 0 rgba(208,215,222,0.2);
|
||||||
|
--color-primer-shadow-focus: 0 0 0 3px rgba(9,105,218,0.3);
|
||||||
|
--color-scale-black: #1b1f24;
|
||||||
|
--color-scale-white: #ffffff;
|
||||||
|
--color-scale-gray-0: #f6f8fa;
|
||||||
|
--color-scale-gray-1: #eaeef2;
|
||||||
|
--color-scale-gray-2: #d0d7de;
|
||||||
|
--color-scale-gray-3: #afb8c1;
|
||||||
|
--color-scale-gray-4: #8c959f;
|
||||||
|
--color-scale-gray-5: #6e7781;
|
||||||
|
--color-scale-gray-6: #57606a;
|
||||||
|
--color-scale-gray-7: #424a53;
|
||||||
|
--color-scale-gray-8: #32383f;
|
||||||
|
--color-scale-gray-9: #24292f;
|
||||||
|
--color-scale-blue-0: #ddf4ff;
|
||||||
|
--color-scale-blue-1: #b6e3ff;
|
||||||
|
--color-scale-blue-2: #80ccff;
|
||||||
|
--color-scale-blue-3: #54aeff;
|
||||||
|
--color-scale-blue-4: #218bff;
|
||||||
|
--color-scale-blue-5: #0969da;
|
||||||
|
--color-scale-blue-6: #0550ae;
|
||||||
|
--color-scale-blue-7: #033d8b;
|
||||||
|
--color-scale-blue-8: #0a3069;
|
||||||
|
--color-scale-blue-9: #002155;
|
||||||
|
--color-scale-green-0: #dafbe1;
|
||||||
|
--color-scale-green-1: #aceebb;
|
||||||
|
--color-scale-green-2: #6fdd8b;
|
||||||
|
--color-scale-green-3: #4ac26b;
|
||||||
|
--color-scale-green-4: #2da44e;
|
||||||
|
--color-scale-green-5: #1a7f37;
|
||||||
|
--color-scale-green-6: #116329;
|
||||||
|
--color-scale-green-7: #044f1e;
|
||||||
|
--color-scale-green-8: #003d16;
|
||||||
|
--color-scale-green-9: #002d11;
|
||||||
|
--color-scale-yellow-0: #fff8c5;
|
||||||
|
--color-scale-yellow-1: #fae17d;
|
||||||
|
--color-scale-yellow-2: #eac54f;
|
||||||
|
--color-scale-yellow-3: #d4a72c;
|
||||||
|
--color-scale-yellow-4: #bf8700;
|
||||||
|
--color-scale-yellow-5: #9a6700;
|
||||||
|
--color-scale-yellow-6: #7d4e00;
|
||||||
|
--color-scale-yellow-7: #633c01;
|
||||||
|
--color-scale-yellow-8: #4d2d00;
|
||||||
|
--color-scale-yellow-9: #3b2300;
|
||||||
|
--color-scale-orange-0: #fff1e5;
|
||||||
|
--color-scale-orange-1: #ffd8b5;
|
||||||
|
--color-scale-orange-2: #ffb77c;
|
||||||
|
--color-scale-orange-3: #fb8f44;
|
||||||
|
--color-scale-orange-4: #e16f24;
|
||||||
|
--color-scale-orange-5: #bc4c00;
|
||||||
|
--color-scale-orange-6: #953800;
|
||||||
|
--color-scale-orange-7: #762c00;
|
||||||
|
--color-scale-orange-8: #5c2200;
|
||||||
|
--color-scale-orange-9: #471700;
|
||||||
|
--color-scale-red-0: #FFEBE9;
|
||||||
|
--color-scale-red-1: #ffcecb;
|
||||||
|
--color-scale-red-2: #ffaba8;
|
||||||
|
--color-scale-red-3: #ff8182;
|
||||||
|
--color-scale-red-4: #fa4549;
|
||||||
|
--color-scale-red-5: #cf222e;
|
||||||
|
--color-scale-red-6: #a40e26;
|
||||||
|
--color-scale-red-7: #82071e;
|
||||||
|
--color-scale-red-8: #660018;
|
||||||
|
--color-scale-red-9: #4c0014;
|
||||||
|
--color-scale-purple-0: #fbefff;
|
||||||
|
--color-scale-purple-1: #ecd8ff;
|
||||||
|
--color-scale-purple-2: #d8b9ff;
|
||||||
|
--color-scale-purple-3: #c297ff;
|
||||||
|
--color-scale-purple-4: #a475f9;
|
||||||
|
--color-scale-purple-5: #8250df;
|
||||||
|
--color-scale-purple-6: #6639ba;
|
||||||
|
--color-scale-purple-7: #512a97;
|
||||||
|
--color-scale-purple-8: #3e1f79;
|
||||||
|
--color-scale-purple-9: #2e1461;
|
||||||
|
--color-scale-pink-0: #ffeff7;
|
||||||
|
--color-scale-pink-1: #ffd3eb;
|
||||||
|
--color-scale-pink-2: #ffadda;
|
||||||
|
--color-scale-pink-3: #ff80c8;
|
||||||
|
--color-scale-pink-4: #e85aad;
|
||||||
|
--color-scale-pink-5: #bf3989;
|
||||||
|
--color-scale-pink-6: #99286e;
|
||||||
|
--color-scale-pink-7: #772057;
|
||||||
|
--color-scale-pink-8: #611347;
|
||||||
|
--color-scale-pink-9: #4d0336;
|
||||||
|
--color-scale-coral-0: #FFF0EB;
|
||||||
|
--color-scale-coral-1: #FFD6CC;
|
||||||
|
--color-scale-coral-2: #FFB4A1;
|
||||||
|
--color-scale-coral-3: #FD8C73;
|
||||||
|
--color-scale-coral-4: #EC6547;
|
||||||
|
--color-scale-coral-5: #C4432B;
|
||||||
|
--color-scale-coral-6: #9E2F1C;
|
||||||
|
--color-scale-coral-7: #801F0F;
|
||||||
|
--color-scale-coral-8: #691105;
|
||||||
|
--color-scale-coral-9: #510901
|
||||||
|
}
|
||||||
|
|
||||||
|
@media(prefers-color-scheme: dark) {
|
||||||
|
:root {
|
||||||
|
--color-canvas-default-transparent: rgba(13,17,23,0);
|
||||||
|
--color-marketing-icon-primary: #79c0ff;
|
||||||
|
--color-marketing-icon-secondary: #1f6feb;
|
||||||
|
--color-diff-blob-addition-num-text: #c9d1d9;
|
||||||
|
--color-diff-blob-addition-fg: #c9d1d9;
|
||||||
|
--color-diff-blob-addition-num-bg: rgba(63,185,80,0.3);
|
||||||
|
--color-diff-blob-addition-line-bg: rgba(46,160,67,0.15);
|
||||||
|
--color-diff-blob-addition-word-bg: rgba(46,160,67,0.4);
|
||||||
|
--color-diff-blob-deletion-num-text: #c9d1d9;
|
||||||
|
--color-diff-blob-deletion-fg: #c9d1d9;
|
||||||
|
--color-diff-blob-deletion-num-bg: rgba(248,81,73,0.3);
|
||||||
|
--color-diff-blob-deletion-line-bg: rgba(248,81,73,0.15);
|
||||||
|
--color-diff-blob-deletion-word-bg: rgba(248,81,73,0.4);
|
||||||
|
--color-diff-blob-hunk-num-bg: rgba(56,139,253,0.4);
|
||||||
|
--color-diff-blob-expander-icon: #8b949e;
|
||||||
|
--color-diff-blob-selected-line-highlight-mix-blend-mode: screen;
|
||||||
|
--color-diffstat-deletion-border: rgba(240,246,252,0.1);
|
||||||
|
--color-diffstat-addition-border: rgba(240,246,252,0.1);
|
||||||
|
--color-diffstat-addition-bg: #3fb950;
|
||||||
|
--color-search-keyword-hl: rgba(210,153,34,0.4);
|
||||||
|
--color-prettylights-syntax-comment: #8b949e;
|
||||||
|
--color-prettylights-syntax-constant: #79c0ff;
|
||||||
|
--color-prettylights-syntax-entity: #d2a8ff;
|
||||||
|
--color-prettylights-syntax-storage-modifier-import: #c9d1d9;
|
||||||
|
--color-prettylights-syntax-entity-tag: #7ee787;
|
||||||
|
--color-prettylights-syntax-keyword: #ff7b72;
|
||||||
|
--color-prettylights-syntax-string: #a5d6ff;
|
||||||
|
--color-prettylights-syntax-variable: #ffa657;
|
||||||
|
--color-prettylights-syntax-brackethighlighter-unmatched: #f85149;
|
||||||
|
--color-prettylights-syntax-invalid-illegal-text: #f0f6fc;
|
||||||
|
--color-prettylights-syntax-invalid-illegal-bg: #8e1519;
|
||||||
|
--color-prettylights-syntax-carriage-return-text: #f0f6fc;
|
||||||
|
--color-prettylights-syntax-carriage-return-bg: #b62324;
|
||||||
|
--color-prettylights-syntax-string-regexp: #7ee787;
|
||||||
|
--color-prettylights-syntax-markup-list: #f2cc60;
|
||||||
|
--color-prettylights-syntax-markup-heading: #1f6feb;
|
||||||
|
--color-prettylights-syntax-markup-italic: #c9d1d9;
|
||||||
|
--color-prettylights-syntax-markup-bold: #c9d1d9;
|
||||||
|
--color-prettylights-syntax-markup-deleted-text: #ffdcd7;
|
||||||
|
--color-prettylights-syntax-markup-deleted-bg: #67060c;
|
||||||
|
--color-prettylights-syntax-markup-inserted-text: #aff5b4;
|
||||||
|
--color-prettylights-syntax-markup-inserted-bg: #033a16;
|
||||||
|
--color-prettylights-syntax-markup-changed-text: #ffdfb6;
|
||||||
|
--color-prettylights-syntax-markup-changed-bg: #5a1e02;
|
||||||
|
--color-prettylights-syntax-markup-ignored-text: #c9d1d9;
|
||||||
|
--color-prettylights-syntax-markup-ignored-bg: #1158c7;
|
||||||
|
--color-prettylights-syntax-meta-diff-range: #d2a8ff;
|
||||||
|
--color-prettylights-syntax-brackethighlighter-angle: #8b949e;
|
||||||
|
--color-prettylights-syntax-sublimelinter-gutter-mark: #484f58;
|
||||||
|
--color-prettylights-syntax-constant-other-reference-link: #a5d6ff;
|
||||||
|
--color-codemirror-text: #c9d1d9;
|
||||||
|
--color-codemirror-bg: #0d1117;
|
||||||
|
--color-codemirror-gutters-bg: #0d1117;
|
||||||
|
--color-codemirror-guttermarker-text: #0d1117;
|
||||||
|
--color-codemirror-guttermarker-subtle-text: #484f58;
|
||||||
|
--color-codemirror-linenumber-text: #8b949e;
|
||||||
|
--color-codemirror-cursor: #c9d1d9;
|
||||||
|
--color-codemirror-selection-bg: rgba(56,139,253,0.4);
|
||||||
|
--color-codemirror-activeline-bg: rgba(110,118,129,0.1);
|
||||||
|
--color-codemirror-matchingbracket-text: #c9d1d9;
|
||||||
|
--color-codemirror-lines-bg: #0d1117;
|
||||||
|
--color-codemirror-syntax-comment: #8b949e;
|
||||||
|
--color-codemirror-syntax-constant: #79c0ff;
|
||||||
|
--color-codemirror-syntax-entity: #d2a8ff;
|
||||||
|
--color-codemirror-syntax-keyword: #ff7b72;
|
||||||
|
--color-codemirror-syntax-storage: #ff7b72;
|
||||||
|
--color-codemirror-syntax-string: #a5d6ff;
|
||||||
|
--color-codemirror-syntax-support: #79c0ff;
|
||||||
|
--color-codemirror-syntax-variable: #ffa657;
|
||||||
|
--color-checks-bg: #010409;
|
||||||
|
--color-checks-run-border-width: 1px;
|
||||||
|
--color-checks-container-border-width: 1px;
|
||||||
|
--color-checks-text-primary: #c9d1d9;
|
||||||
|
--color-checks-text-secondary: #8b949e;
|
||||||
|
--color-checks-text-link: #58a6ff;
|
||||||
|
--color-checks-btn-icon: #8b949e;
|
||||||
|
--color-checks-btn-hover-icon: #c9d1d9;
|
||||||
|
--color-checks-btn-hover-bg: rgba(110,118,129,0.1);
|
||||||
|
--color-checks-input-text: #8b949e;
|
||||||
|
--color-checks-input-placeholder-text: #484f58;
|
||||||
|
--color-checks-input-focus-text: #c9d1d9;
|
||||||
|
--color-checks-input-bg: #161b22;
|
||||||
|
--color-checks-input-shadow: none;
|
||||||
|
--color-checks-donut-error: #f85149;
|
||||||
|
--color-checks-donut-pending: #d29922;
|
||||||
|
--color-checks-donut-success: #2ea043;
|
||||||
|
--color-checks-donut-neutral: #8b949e;
|
||||||
|
--color-checks-dropdown-text: #c9d1d9;
|
||||||
|
--color-checks-dropdown-bg: #161b22;
|
||||||
|
--color-checks-dropdown-border: #30363d;
|
||||||
|
--color-checks-dropdown-shadow: rgba(1,4,9,0.3);
|
||||||
|
--color-checks-dropdown-hover-text: #c9d1d9;
|
||||||
|
--color-checks-dropdown-hover-bg: rgba(110,118,129,0.1);
|
||||||
|
--color-checks-dropdown-btn-hover-text: #c9d1d9;
|
||||||
|
--color-checks-dropdown-btn-hover-bg: rgba(110,118,129,0.1);
|
||||||
|
--color-checks-scrollbar-thumb-bg: rgba(110,118,129,0.4);
|
||||||
|
--color-checks-header-label-text: #8b949e;
|
||||||
|
--color-checks-header-label-open-text: #c9d1d9;
|
||||||
|
--color-checks-header-border: #21262d;
|
||||||
|
--color-checks-header-icon: #8b949e;
|
||||||
|
--color-checks-line-text: #8b949e;
|
||||||
|
--color-checks-line-num-text: #484f58;
|
||||||
|
--color-checks-line-timestamp-text: #484f58;
|
||||||
|
--color-checks-line-hover-bg: rgba(110,118,129,0.1);
|
||||||
|
--color-checks-line-selected-bg: rgba(56,139,253,0.15);
|
||||||
|
--color-checks-line-selected-num-text: #58a6ff;
|
||||||
|
--color-checks-line-dt-fm-text: #f0f6fc;
|
||||||
|
--color-checks-line-dt-fm-bg: #9e6a03;
|
||||||
|
--color-checks-gate-bg: rgba(187,128,9,0.15);
|
||||||
|
--color-checks-gate-text: #8b949e;
|
||||||
|
--color-checks-gate-waiting-text: #d29922;
|
||||||
|
--color-checks-step-header-open-bg: #161b22;
|
||||||
|
--color-checks-step-error-text: #f85149;
|
||||||
|
--color-checks-step-warning-text: #d29922;
|
||||||
|
--color-checks-logline-text: #8b949e;
|
||||||
|
--color-checks-logline-num-text: #484f58;
|
||||||
|
--color-checks-logline-debug-text: #a371f7;
|
||||||
|
--color-checks-logline-error-text: #8b949e;
|
||||||
|
--color-checks-logline-error-num-text: #484f58;
|
||||||
|
--color-checks-logline-error-bg: rgba(248,81,73,0.15);
|
||||||
|
--color-checks-logline-warning-text: #8b949e;
|
||||||
|
--color-checks-logline-warning-num-text: #d29922;
|
||||||
|
--color-checks-logline-warning-bg: rgba(187,128,9,0.15);
|
||||||
|
--color-checks-logline-command-text: #58a6ff;
|
||||||
|
--color-checks-logline-section-text: #3fb950;
|
||||||
|
--color-checks-ansi-black: #0d1117;
|
||||||
|
--color-checks-ansi-black-bright: #161b22;
|
||||||
|
--color-checks-ansi-white: #b1bac4;
|
||||||
|
--color-checks-ansi-white-bright: #b1bac4;
|
||||||
|
--color-checks-ansi-gray: #6e7681;
|
||||||
|
--color-checks-ansi-red: #ff7b72;
|
||||||
|
--color-checks-ansi-red-bright: #ffa198;
|
||||||
|
--color-checks-ansi-green: #3fb950;
|
||||||
|
--color-checks-ansi-green-bright: #56d364;
|
||||||
|
--color-checks-ansi-yellow: #d29922;
|
||||||
|
--color-checks-ansi-yellow-bright: #e3b341;
|
||||||
|
--color-checks-ansi-blue: #58a6ff;
|
||||||
|
--color-checks-ansi-blue-bright: #79c0ff;
|
||||||
|
--color-checks-ansi-magenta: #bc8cff;
|
||||||
|
--color-checks-ansi-magenta-bright: #d2a8ff;
|
||||||
|
--color-checks-ansi-cyan: #76e3ea;
|
||||||
|
--color-checks-ansi-cyan-bright: #b3f0ff;
|
||||||
|
--color-project-header-bg: #0d1117;
|
||||||
|
--color-project-sidebar-bg: #161b22;
|
||||||
|
--color-project-gradient-in: #161b22;
|
||||||
|
--color-project-gradient-out: rgba(22,27,34,0);
|
||||||
|
--color-mktg-success: rgba(41,147,61,1);
|
||||||
|
--color-mktg-info: rgba(42,123,243,1);
|
||||||
|
--color-mktg-bg-shade-gradient-top: rgba(1,4,9,0.065);
|
||||||
|
--color-mktg-bg-shade-gradient-bottom: rgba(1,4,9,0);
|
||||||
|
--color-mktg-btn-bg-top: hsla(228,82%,66%,1);
|
||||||
|
--color-mktg-btn-bg-bottom: #4969ed;
|
||||||
|
--color-mktg-btn-bg-overlay-top: hsla(228,74%,59%,1);
|
||||||
|
--color-mktg-btn-bg-overlay-bottom: #3355e0;
|
||||||
|
--color-mktg-btn-text: #f0f6fc;
|
||||||
|
--color-mktg-btn-primary-bg-top: hsla(137,56%,46%,1);
|
||||||
|
--color-mktg-btn-primary-bg-bottom: #2ea44f;
|
||||||
|
--color-mktg-btn-primary-bg-overlay-top: hsla(134,60%,38%,1);
|
||||||
|
--color-mktg-btn-primary-bg-overlay-bottom: #22863a;
|
||||||
|
--color-mktg-btn-primary-text: #f0f6fc;
|
||||||
|
--color-mktg-btn-enterprise-bg-top: hsla(249,100%,72%,1);
|
||||||
|
--color-mktg-btn-enterprise-bg-bottom: #6f57ff;
|
||||||
|
--color-mktg-btn-enterprise-bg-overlay-top: hsla(248,65%,63%,1);
|
||||||
|
--color-mktg-btn-enterprise-bg-overlay-bottom: #614eda;
|
||||||
|
--color-mktg-btn-enterprise-text: #f0f6fc;
|
||||||
|
--color-mktg-btn-outline-text: #f0f6fc;
|
||||||
|
--color-mktg-btn-outline-border: rgba(240,246,252,0.3);
|
||||||
|
--color-mktg-btn-outline-hover-text: #f0f6fc;
|
||||||
|
--color-mktg-btn-outline-hover-border: rgba(240,246,252,0.5);
|
||||||
|
--color-mktg-btn-outline-focus-border: #f0f6fc;
|
||||||
|
--color-mktg-btn-outline-focus-border-inset: rgba(240,246,252,0.5);
|
||||||
|
--color-mktg-btn-dark-text: #f0f6fc;
|
||||||
|
--color-mktg-btn-dark-border: rgba(240,246,252,0.3);
|
||||||
|
--color-mktg-btn-dark-hover-text: #f0f6fc;
|
||||||
|
--color-mktg-btn-dark-hover-border: rgba(240,246,252,0.5);
|
||||||
|
--color-mktg-btn-dark-focus-border: #f0f6fc;
|
||||||
|
--color-mktg-btn-dark-focus-border-inset: rgba(240,246,252,0.5);
|
||||||
|
--color-avatar-bg: rgba(240,246,252,0.1);
|
||||||
|
--color-avatar-border: rgba(240,246,252,0.1);
|
||||||
|
--color-avatar-stack-fade: #30363d;
|
||||||
|
--color-avatar-stack-fade-more: #21262d;
|
||||||
|
--color-avatar-child-shadow: -2px -2px 0 #0d1117;
|
||||||
|
--color-topic-tag-border: rgba(0,0,0,0);
|
||||||
|
--color-select-menu-backdrop-border: #484f58;
|
||||||
|
--color-select-menu-tap-highlight: rgba(48,54,61,0.5);
|
||||||
|
--color-select-menu-tap-focus-bg: #0c2d6b;
|
||||||
|
--color-overlay-shadow: 0 0 0 1px #30363d, 0 16px 32px rgba(1,4,9,0.85);
|
||||||
|
--color-header-text: rgba(240,246,252,0.7);
|
||||||
|
--color-header-bg: #161b22;
|
||||||
|
--color-header-logo: #f0f6fc;
|
||||||
|
--color-header-search-bg: #0d1117;
|
||||||
|
--color-header-search-border: #30363d;
|
||||||
|
--color-sidenav-selected-bg: #21262d;
|
||||||
|
--color-menu-bg-active: #161b22;
|
||||||
|
--color-control-transparent-bg-hover: #656c7633;
|
||||||
|
--color-input-disabled-bg: rgba(110,118,129,0);
|
||||||
|
--color-timeline-badge-bg: #21262d;
|
||||||
|
--color-ansi-black: #484f58;
|
||||||
|
--color-ansi-black-bright: #6e7681;
|
||||||
|
--color-ansi-white: #b1bac4;
|
||||||
|
--color-ansi-white-bright: #f0f6fc;
|
||||||
|
--color-ansi-gray: #6e7681;
|
||||||
|
--color-ansi-red: #ff7b72;
|
||||||
|
--color-ansi-red-bright: #ffa198;
|
||||||
|
--color-ansi-green: #3fb950;
|
||||||
|
--color-ansi-green-bright: #56d364;
|
||||||
|
--color-ansi-yellow: #d29922;
|
||||||
|
--color-ansi-yellow-bright: #e3b341;
|
||||||
|
--color-ansi-blue: #58a6ff;
|
||||||
|
--color-ansi-blue-bright: #79c0ff;
|
||||||
|
--color-ansi-magenta: #bc8cff;
|
||||||
|
--color-ansi-magenta-bright: #d2a8ff;
|
||||||
|
--color-ansi-cyan: #39c5cf;
|
||||||
|
--color-ansi-cyan-bright: #56d4dd;
|
||||||
|
--color-btn-text: #c9d1d9;
|
||||||
|
--color-btn-bg: #21262d;
|
||||||
|
--color-btn-border: rgba(240,246,252,0.1);
|
||||||
|
--color-btn-shadow: 0 0 transparent;
|
||||||
|
--color-btn-inset-shadow: 0 0 transparent;
|
||||||
|
--color-btn-hover-bg: #30363d;
|
||||||
|
--color-btn-hover-border: #8b949e;
|
||||||
|
--color-btn-active-bg: hsla(212,12%,18%,1);
|
||||||
|
--color-btn-active-border: #6e7681;
|
||||||
|
--color-btn-selected-bg: #161b22;
|
||||||
|
--color-btn-focus-bg: #21262d;
|
||||||
|
--color-btn-focus-border: #8b949e;
|
||||||
|
--color-btn-focus-shadow: 0 0 0 3px rgba(139,148,158,0.3);
|
||||||
|
--color-btn-shadow-active: inset 0 0.15em 0.3em rgba(1,4,9,0.15);
|
||||||
|
--color-btn-shadow-input-focus: 0 0 0 0.2em rgba(31,111,235,0.3);
|
||||||
|
--color-btn-counter-bg: #30363d;
|
||||||
|
--color-btn-primary-text: #ffffff;
|
||||||
|
--color-btn-primary-bg: #238636;
|
||||||
|
--color-btn-primary-border: rgba(240,246,252,0.1);
|
||||||
|
--color-btn-primary-shadow: 0 0 transparent;
|
||||||
|
--color-btn-primary-inset-shadow: 0 0 transparent;
|
||||||
|
--color-btn-primary-hover-bg: #2ea043;
|
||||||
|
--color-btn-primary-hover-border: rgba(240,246,252,0.1);
|
||||||
|
--color-btn-primary-selected-bg: #238636;
|
||||||
|
--color-btn-primary-selected-shadow: 0 0 transparent;
|
||||||
|
--color-btn-primary-disabled-text: rgba(240,246,252,0.5);
|
||||||
|
--color-btn-primary-disabled-bg: rgba(35,134,54,0.6);
|
||||||
|
--color-btn-primary-disabled-border: rgba(240,246,252,0.1);
|
||||||
|
--color-btn-primary-focus-bg: #238636;
|
||||||
|
--color-btn-primary-focus-border: rgba(240,246,252,0.1);
|
||||||
|
--color-btn-primary-focus-shadow: 0 0 0 3px rgba(46,164,79,0.4);
|
||||||
|
--color-btn-primary-icon: #f0f6fc;
|
||||||
|
--color-btn-primary-counter-bg: rgba(240,246,252,0.2);
|
||||||
|
--color-btn-outline-text: #58a6ff;
|
||||||
|
--color-btn-outline-hover-text: #58a6ff;
|
||||||
|
--color-btn-outline-hover-bg: #30363d;
|
||||||
|
--color-btn-outline-hover-border: rgba(240,246,252,0.1);
|
||||||
|
--color-btn-outline-hover-shadow: 0 1px 0 rgba(1,4,9,0.1);
|
||||||
|
--color-btn-outline-hover-inset-shadow: inset 0 1px 0 rgba(240,246,252,0.03);
|
||||||
|
--color-btn-outline-hover-counter-bg: rgba(240,246,252,0.2);
|
||||||
|
--color-btn-outline-selected-text: #f0f6fc;
|
||||||
|
--color-btn-outline-selected-bg: #0d419d;
|
||||||
|
--color-btn-outline-selected-border: rgba(240,246,252,0.1);
|
||||||
|
--color-btn-outline-selected-shadow: 0 0 transparent;
|
||||||
|
--color-btn-outline-disabled-text: rgba(88,166,255,0.5);
|
||||||
|
--color-btn-outline-disabled-bg: #0d1117;
|
||||||
|
--color-btn-outline-disabled-counter-bg: rgba(31,111,235,0.05);
|
||||||
|
--color-btn-outline-focus-border: rgba(240,246,252,0.1);
|
||||||
|
--color-btn-outline-focus-shadow: 0 0 0 3px rgba(17,88,199,0.4);
|
||||||
|
--color-btn-outline-counter-bg: rgba(31,111,235,0.1);
|
||||||
|
--color-btn-danger-text: #f85149;
|
||||||
|
--color-btn-danger-hover-text: #f0f6fc;
|
||||||
|
--color-btn-danger-hover-bg: #da3633;
|
||||||
|
--color-btn-danger-hover-border: #f85149;
|
||||||
|
--color-btn-danger-hover-shadow: 0 0 transparent;
|
||||||
|
--color-btn-danger-hover-inset-shadow: 0 0 transparent;
|
||||||
|
--color-btn-danger-hover-icon: #f0f6fc;
|
||||||
|
--color-btn-danger-hover-counter-bg: rgba(255,255,255,0.2);
|
||||||
|
--color-btn-danger-selected-text: #ffffff;
|
||||||
|
--color-btn-danger-selected-bg: #b62324;
|
||||||
|
--color-btn-danger-selected-border: #ff7b72;
|
||||||
|
--color-btn-danger-selected-shadow: 0 0 transparent;
|
||||||
|
--color-btn-danger-disabled-text: rgba(248,81,73,0.5);
|
||||||
|
--color-btn-danger-disabled-bg: #0d1117;
|
||||||
|
--color-btn-danger-disabled-counter-bg: rgba(218,54,51,0.05);
|
||||||
|
--color-btn-danger-focus-border: #f85149;
|
||||||
|
--color-btn-danger-focus-shadow: 0 0 0 3px rgba(248,81,73,0.4);
|
||||||
|
--color-btn-danger-counter-bg: rgba(218,54,51,0.1);
|
||||||
|
--color-btn-danger-icon: #f85149;
|
||||||
|
--color-underlinenav-icon: #484f58;
|
||||||
|
--color-underlinenav-border-hover: rgba(110,118,129,0.4);
|
||||||
|
--color-fg-default: #c9d1d9;
|
||||||
|
--color-fg-muted: #8b949e;
|
||||||
|
--color-fg-subtle: #484f58;
|
||||||
|
--color-fg-on-emphasis: #f0f6fc;
|
||||||
|
--color-canvas-default: #0d1117;
|
||||||
|
--color-canvas-overlay: #161b22;
|
||||||
|
--color-canvas-inset: #010409;
|
||||||
|
--color-canvas-subtle: #161b22;
|
||||||
|
--color-border-default: #30363d;
|
||||||
|
--color-border-muted: #21262d;
|
||||||
|
--color-border-subtle: rgba(240,246,252,0.1);
|
||||||
|
--color-shadow-small: 0 0 transparent;
|
||||||
|
--color-shadow-medium: 0 3px 6px #010409;
|
||||||
|
--color-shadow-large: 0 8px 24px #010409;
|
||||||
|
--color-shadow-extra-large: 0 12px 48px #010409;
|
||||||
|
--color-neutral-emphasis-plus: #6e7681;
|
||||||
|
--color-neutral-emphasis: #6e7681;
|
||||||
|
--color-neutral-muted: rgba(110,118,129,0.4);
|
||||||
|
--color-neutral-subtle: rgba(110,118,129,0.1);
|
||||||
|
--color-accent-fg: #58a6ff;
|
||||||
|
--color-accent-emphasis: #1f6feb;
|
||||||
|
--color-accent-muted: rgba(56,139,253,0.4);
|
||||||
|
--color-accent-subtle: rgba(56,139,253,0.15);
|
||||||
|
--color-success-fg: #3fb950;
|
||||||
|
--color-success-emphasis: #238636;
|
||||||
|
--color-success-muted: rgba(46,160,67,0.4);
|
||||||
|
--color-success-subtle: rgba(46,160,67,0.15);
|
||||||
|
--color-attention-fg: #d29922;
|
||||||
|
--color-attention-emphasis: #9e6a03;
|
||||||
|
--color-attention-muted: rgba(187,128,9,0.4);
|
||||||
|
--color-attention-subtle: rgba(187,128,9,0.15);
|
||||||
|
--color-severe-fg: #db6d28;
|
||||||
|
--color-severe-emphasis: #bd561d;
|
||||||
|
--color-severe-muted: rgba(219,109,40,0.4);
|
||||||
|
--color-severe-subtle: rgba(219,109,40,0.15);
|
||||||
|
--color-danger-fg: #f85149;
|
||||||
|
--color-danger-emphasis: #da3633;
|
||||||
|
--color-danger-muted: rgba(248,81,73,0.4);
|
||||||
|
--color-danger-subtle: rgba(248,81,73,0.15);
|
||||||
|
--color-done-fg: #a371f7;
|
||||||
|
--color-done-emphasis: #8957e5;
|
||||||
|
--color-done-muted: rgba(163,113,247,0.4);
|
||||||
|
--color-done-subtle: rgba(163,113,247,0.15);
|
||||||
|
--color-sponsors-fg: #db61a2;
|
||||||
|
--color-sponsors-emphasis: #bf4b8a;
|
||||||
|
--color-sponsors-muted: rgba(219,97,162,0.4);
|
||||||
|
--color-sponsors-subtle: rgba(219,97,162,0.15);
|
||||||
|
--color-primer-canvas-backdrop: rgba(1,4,9,0.8);
|
||||||
|
--color-primer-canvas-sticky: rgba(13,17,23,0.95);
|
||||||
|
--color-primer-border-active: #F78166;
|
||||||
|
--color-primer-border-contrast: rgba(240,246,252,0.2);
|
||||||
|
--color-primer-shadow-highlight: 0 0 transparent;
|
||||||
|
--color-primer-shadow-inset: 0 0 transparent;
|
||||||
|
--color-primer-shadow-focus: 0 0 0 3px #0c2d6b;
|
||||||
|
--color-scale-black: #010409;
|
||||||
|
--color-scale-white: #f0f6fc;
|
||||||
|
--color-scale-gray-0: #f0f6fc;
|
||||||
|
--color-scale-gray-1: #c9d1d9;
|
||||||
|
--color-scale-gray-2: #b1bac4;
|
||||||
|
--color-scale-gray-3: #8b949e;
|
||||||
|
--color-scale-gray-4: #6e7681;
|
||||||
|
--color-scale-gray-5: #484f58;
|
||||||
|
--color-scale-gray-6: #30363d;
|
||||||
|
--color-scale-gray-7: #21262d;
|
||||||
|
--color-scale-gray-8: #161b22;
|
||||||
|
--color-scale-gray-9: #0d1117;
|
||||||
|
--color-scale-blue-0: #cae8ff;
|
||||||
|
--color-scale-blue-1: #a5d6ff;
|
||||||
|
--color-scale-blue-2: #79c0ff;
|
||||||
|
--color-scale-blue-3: #58a6ff;
|
||||||
|
--color-scale-blue-4: #388bfd;
|
||||||
|
--color-scale-blue-5: #1f6feb;
|
||||||
|
--color-scale-blue-6: #1158c7;
|
||||||
|
--color-scale-blue-7: #0d419d;
|
||||||
|
--color-scale-blue-8: #0c2d6b;
|
||||||
|
--color-scale-blue-9: #051d4d;
|
||||||
|
--color-scale-green-0: #aff5b4;
|
||||||
|
--color-scale-green-1: #7ee787;
|
||||||
|
--color-scale-green-2: #56d364;
|
||||||
|
--color-scale-green-3: #3fb950;
|
||||||
|
--color-scale-green-4: #2ea043;
|
||||||
|
--color-scale-green-5: #238636;
|
||||||
|
--color-scale-green-6: #196c2e;
|
||||||
|
--color-scale-green-7: #0f5323;
|
||||||
|
--color-scale-green-8: #033a16;
|
||||||
|
--color-scale-green-9: #04260f;
|
||||||
|
--color-scale-yellow-0: #f8e3a1;
|
||||||
|
--color-scale-yellow-1: #f2cc60;
|
||||||
|
--color-scale-yellow-2: #e3b341;
|
||||||
|
--color-scale-yellow-3: #d29922;
|
||||||
|
--color-scale-yellow-4: #bb8009;
|
||||||
|
--color-scale-yellow-5: #9e6a03;
|
||||||
|
--color-scale-yellow-6: #845306;
|
||||||
|
--color-scale-yellow-7: #693e00;
|
||||||
|
--color-scale-yellow-8: #4b2900;
|
||||||
|
--color-scale-yellow-9: #341a00;
|
||||||
|
--color-scale-orange-0: #ffdfb6;
|
||||||
|
--color-scale-orange-1: #ffc680;
|
||||||
|
--color-scale-orange-2: #ffa657;
|
||||||
|
--color-scale-orange-3: #f0883e;
|
||||||
|
--color-scale-orange-4: #db6d28;
|
||||||
|
--color-scale-orange-5: #bd561d;
|
||||||
|
--color-scale-orange-6: #9b4215;
|
||||||
|
--color-scale-orange-7: #762d0a;
|
||||||
|
--color-scale-orange-8: #5a1e02;
|
||||||
|
--color-scale-orange-9: #3d1300;
|
||||||
|
--color-scale-red-0: #ffdcd7;
|
||||||
|
--color-scale-red-1: #ffc1ba;
|
||||||
|
--color-scale-red-2: #ffa198;
|
||||||
|
--color-scale-red-3: #ff7b72;
|
||||||
|
--color-scale-red-4: #f85149;
|
||||||
|
--color-scale-red-5: #da3633;
|
||||||
|
--color-scale-red-6: #b62324;
|
||||||
|
--color-scale-red-7: #8e1519;
|
||||||
|
--color-scale-red-8: #67060c;
|
||||||
|
--color-scale-red-9: #490202;
|
||||||
|
--color-scale-purple-0: #eddeff;
|
||||||
|
--color-scale-purple-1: #e2c5ff;
|
||||||
|
--color-scale-purple-2: #d2a8ff;
|
||||||
|
--color-scale-purple-3: #bc8cff;
|
||||||
|
--color-scale-purple-4: #a371f7;
|
||||||
|
--color-scale-purple-5: #8957e5;
|
||||||
|
--color-scale-purple-6: #6e40c9;
|
||||||
|
--color-scale-purple-7: #553098;
|
||||||
|
--color-scale-purple-8: #3c1e70;
|
||||||
|
--color-scale-purple-9: #271052;
|
||||||
|
--color-scale-pink-0: #ffdaec;
|
||||||
|
--color-scale-pink-1: #ffbedd;
|
||||||
|
--color-scale-pink-2: #ff9bce;
|
||||||
|
--color-scale-pink-3: #f778ba;
|
||||||
|
--color-scale-pink-4: #db61a2;
|
||||||
|
--color-scale-pink-5: #bf4b8a;
|
||||||
|
--color-scale-pink-6: #9e3670;
|
||||||
|
--color-scale-pink-7: #7d2457;
|
||||||
|
--color-scale-pink-8: #5e103e;
|
||||||
|
--color-scale-pink-9: #42062a;
|
||||||
|
--color-scale-coral-0: #FFDDD2;
|
||||||
|
--color-scale-coral-1: #FFC2B2;
|
||||||
|
--color-scale-coral-2: #FFA28B;
|
||||||
|
--color-scale-coral-3: #F78166;
|
||||||
|
--color-scale-coral-4: #EA6045;
|
||||||
|
--color-scale-coral-5: #CF462D;
|
||||||
|
--color-scale-coral-6: #AC3220;
|
||||||
|
--color-scale-coral-7: #872012;
|
||||||
|
--color-scale-coral-8: #640D04;
|
||||||
|
--color-scale-coral-9: #460701
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -203,4 +203,60 @@ body {
|
|||||||
cursor: pointer;
|
cursor: pointer;
|
||||||
padding: 0;
|
padding: 0;
|
||||||
font: inherit;
|
font: inherit;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/* Auth token section */
|
||||||
|
.auth-token-section {
|
||||||
|
margin: 16px 0;
|
||||||
|
padding: 16px;
|
||||||
|
background-color: #f6f8fa;
|
||||||
|
border-radius: 6px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.auth-token-description {
|
||||||
|
font-size: 12px;
|
||||||
|
color: #656d76;
|
||||||
|
margin-bottom: 12px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.auth-token-container {
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
gap: 8px;
|
||||||
|
background-color: #ffffff;
|
||||||
|
padding: 8px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.auth-token-code {
|
||||||
|
font-family: 'SFMono-Regular', Consolas, 'Liberation Mono', Menlo, monospace;
|
||||||
|
font-size: 12px;
|
||||||
|
color: #1f2328;
|
||||||
|
border: none;
|
||||||
|
flex: 1;
|
||||||
|
padding: 0;
|
||||||
|
word-break: break-all;
|
||||||
|
}
|
||||||
|
|
||||||
|
.auth-token-refresh {
|
||||||
|
flex: none;
|
||||||
|
height: 24px;
|
||||||
|
width: 24px;
|
||||||
|
border: none;
|
||||||
|
outline: none;
|
||||||
|
color: var(--color-fg-muted);
|
||||||
|
background: transparent;
|
||||||
|
padding: 4px;
|
||||||
|
cursor: pointer;
|
||||||
|
display: inline-flex;
|
||||||
|
align-items: center;
|
||||||
|
justify-content: center;
|
||||||
|
border-radius: 4px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.auth-token-refresh svg {
|
||||||
|
margin: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.auth-token-refresh:not(:disabled):hover {
|
||||||
|
background-color: var(--color-btn-selected-bg);
|
||||||
|
}
|
||||||
@@ -14,9 +14,11 @@
|
|||||||
* limitations under the License.
|
* limitations under the License.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
import React, { useState, useEffect, useCallback } from 'react';
|
import React, { useCallback, useEffect, useState } from 'react';
|
||||||
import { createRoot } from 'react-dom/client';
|
import { createRoot } from 'react-dom/client';
|
||||||
import { Button, TabItem } from './tabItem';
|
import { Button, TabItem } from './tabItem';
|
||||||
|
import { AuthTokenSection, getOrCreateAuthToken } from './authToken';
|
||||||
|
|
||||||
import type { TabInfo } from './tabItem';
|
import type { TabInfo } from './tabItem';
|
||||||
|
|
||||||
type Status =
|
type Status =
|
||||||
@@ -37,54 +39,79 @@ const ConnectApp: React.FC = () => {
|
|||||||
const [newTab, setNewTab] = useState<boolean>(false);
|
const [newTab, setNewTab] = useState<boolean>(false);
|
||||||
|
|
||||||
useEffect(() => {
|
useEffect(() => {
|
||||||
const params = new URLSearchParams(window.location.search);
|
const runAsync = async () => {
|
||||||
const relayUrl = params.get('mcpRelayUrl');
|
const params = new URLSearchParams(window.location.search);
|
||||||
|
const relayUrl = params.get('mcpRelayUrl');
|
||||||
|
|
||||||
if (!relayUrl) {
|
if (!relayUrl) {
|
||||||
setShowButtons(false);
|
handleReject('Missing mcpRelayUrl parameter in URL.');
|
||||||
setStatus({ type: 'error', message: 'Missing mcpRelayUrl parameter in URL.' });
|
return;
|
||||||
return;
|
}
|
||||||
}
|
|
||||||
|
|
||||||
setMcpRelayUrl(relayUrl);
|
try {
|
||||||
|
const host = new URL(relayUrl).hostname;
|
||||||
try {
|
if (host !== '127.0.0.1' && host !== '[::1]') {
|
||||||
const client = JSON.parse(params.get('client') || '{}');
|
handleReject(`MCP extension only allows loopback connections (127.0.0.1 or [::1]). Received host: ${host}`);
|
||||||
const info = `${client.name}/${client.version}`;
|
return;
|
||||||
setClientInfo(info);
|
|
||||||
setStatus({
|
|
||||||
type: 'connecting',
|
|
||||||
message: `🎭 Playwright MCP started from "${info}" is trying to connect. Do you want to continue?`
|
|
||||||
});
|
|
||||||
} catch (e) {
|
|
||||||
setStatus({ type: 'error', message: 'Failed to parse client version.' });
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
const parsedVersion = parseInt(params.get('protocolVersion') ?? '', 10);
|
|
||||||
const requiredVersion = isNaN(parsedVersion) ? 1 : parsedVersion;
|
|
||||||
if (requiredVersion > SUPPORTED_PROTOCOL_VERSION) {
|
|
||||||
const extensionVersion = chrome.runtime.getManifest().version;
|
|
||||||
setShowButtons(false);
|
|
||||||
setShowTabList(false);
|
|
||||||
setStatus({
|
|
||||||
type: 'error',
|
|
||||||
versionMismatch: {
|
|
||||||
extensionVersion,
|
|
||||||
}
|
}
|
||||||
});
|
} catch (e) {
|
||||||
return;
|
handleReject(`Invalid mcpRelayUrl parameter in URL: ${relayUrl}. ${e}`);
|
||||||
}
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
void connectToMCPRelay(relayUrl);
|
setMcpRelayUrl(relayUrl);
|
||||||
|
|
||||||
// If this is a browser_navigate command, hide the tab list and show simple allow/reject
|
try {
|
||||||
if (params.get('newTab') === 'true') {
|
const client = JSON.parse(params.get('client') || '{}');
|
||||||
setNewTab(true);
|
const info = `${client.name}/${client.version}`;
|
||||||
setShowTabList(false);
|
setClientInfo(info);
|
||||||
} else {
|
setStatus({
|
||||||
void loadTabs();
|
type: 'connecting',
|
||||||
}
|
message: `🎭 Playwright MCP started from "${info}" is trying to connect. Do you want to continue?`
|
||||||
|
});
|
||||||
|
} catch (e) {
|
||||||
|
setStatus({ type: 'error', message: 'Failed to parse client version.' });
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const parsedVersion = parseInt(params.get('protocolVersion') ?? '', 10);
|
||||||
|
const requiredVersion = isNaN(parsedVersion) ? 1 : parsedVersion;
|
||||||
|
if (requiredVersion > SUPPORTED_PROTOCOL_VERSION) {
|
||||||
|
const extensionVersion = chrome.runtime.getManifest().version;
|
||||||
|
setShowButtons(false);
|
||||||
|
setShowTabList(false);
|
||||||
|
setStatus({
|
||||||
|
type: 'error',
|
||||||
|
versionMismatch: {
|
||||||
|
extensionVersion,
|
||||||
|
}
|
||||||
|
});
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const expectedToken = getOrCreateAuthToken();
|
||||||
|
const token = params.get('token');
|
||||||
|
if (token === expectedToken) {
|
||||||
|
await connectToMCPRelay(relayUrl);
|
||||||
|
await handleConnectToTab();
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
if (token) {
|
||||||
|
handleReject('Invalid token provided.');
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
await connectToMCPRelay(relayUrl);
|
||||||
|
|
||||||
|
// If this is a browser_navigate command, hide the tab list and show simple allow/reject
|
||||||
|
if (params.get('newTab') === 'true') {
|
||||||
|
setNewTab(true);
|
||||||
|
setShowTabList(false);
|
||||||
|
} else {
|
||||||
|
await loadTabs();
|
||||||
|
}
|
||||||
|
};
|
||||||
|
void runAsync();
|
||||||
}, []);
|
}, []);
|
||||||
|
|
||||||
const handleReject = useCallback((message: string) => {
|
const handleReject = useCallback((message: string) => {
|
||||||
@@ -94,7 +121,6 @@ const ConnectApp: React.FC = () => {
|
|||||||
}, []);
|
}, []);
|
||||||
|
|
||||||
const connectToMCPRelay = useCallback(async (mcpRelayUrl: string) => {
|
const connectToMCPRelay = useCallback(async (mcpRelayUrl: string) => {
|
||||||
|
|
||||||
const response = await chrome.runtime.sendMessage({ type: 'connectToMCPRelay', mcpRelayUrl });
|
const response = await chrome.runtime.sendMessage({ type: 'connectToMCPRelay', mcpRelayUrl });
|
||||||
if (!response.success)
|
if (!response.success)
|
||||||
handleReject(response.error);
|
handleReject(response.error);
|
||||||
@@ -174,6 +200,10 @@ const ConnectApp: React.FC = () => {
|
|||||||
</div>
|
</div>
|
||||||
)}
|
)}
|
||||||
|
|
||||||
|
{status?.type === 'connecting' && (
|
||||||
|
<AuthTokenSection />
|
||||||
|
)}
|
||||||
|
|
||||||
{showTabList && (
|
{showTabList && (
|
||||||
<div>
|
<div>
|
||||||
<div className='tab-section-title'>
|
<div className='tab-section-title'>
|
||||||
39
packages/extension/src/ui/copyToClipboard.css
Normal file
@@ -0,0 +1,39 @@
|
|||||||
|
/*
|
||||||
|
Copyright (c) Microsoft Corporation.
|
||||||
|
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
you may not use this file except in compliance with the License.
|
||||||
|
You may obtain a copy of the License at
|
||||||
|
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
See the License for the specific language governing permissions and
|
||||||
|
limitations under the License.
|
||||||
|
*/
|
||||||
|
|
||||||
|
.copy-icon {
|
||||||
|
flex: none;
|
||||||
|
height: 24px;
|
||||||
|
width: 24px;
|
||||||
|
border: none;
|
||||||
|
outline: none;
|
||||||
|
color: var(--color-fg-muted);
|
||||||
|
background: transparent;
|
||||||
|
padding: 4px;
|
||||||
|
cursor: pointer;
|
||||||
|
display: inline-flex;
|
||||||
|
align-items: center;
|
||||||
|
justify-content: center;
|
||||||
|
border-radius: 4px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.copy-icon svg {
|
||||||
|
margin: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.copy-icon:not(:disabled):hover {
|
||||||
|
background-color: var(--color-btn-selected-bg);
|
||||||
|
}
|
||||||
54
packages/extension/src/ui/copyToClipboard.tsx
Normal file
@@ -0,0 +1,54 @@
|
|||||||
|
/**
|
||||||
|
* Copyright (c) Microsoft Corporation.
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import * as React from 'react';
|
||||||
|
import * as icons from './icons';
|
||||||
|
import './copyToClipboard.css';
|
||||||
|
|
||||||
|
type CopyToClipboardProps = {
|
||||||
|
value: string;
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A copy to clipboard button.
|
||||||
|
*/
|
||||||
|
export const CopyToClipboard: React.FunctionComponent<CopyToClipboardProps> = ({ value }) => {
|
||||||
|
type IconType = 'copy' | 'check' | 'cross';
|
||||||
|
const [icon, setIcon] = React.useState<IconType>('copy');
|
||||||
|
|
||||||
|
React.useEffect(() => {
|
||||||
|
setIcon('copy');
|
||||||
|
}, [value]);
|
||||||
|
|
||||||
|
React.useEffect(() => {
|
||||||
|
if (icon === 'check') {
|
||||||
|
const timeout = setTimeout(() => {
|
||||||
|
setIcon('copy');
|
||||||
|
}, 3000);
|
||||||
|
return () => clearTimeout(timeout);
|
||||||
|
}
|
||||||
|
}, [icon]);
|
||||||
|
|
||||||
|
const handleCopy = React.useCallback(() => {
|
||||||
|
navigator.clipboard.writeText(value).then(() => {
|
||||||
|
setIcon('check');
|
||||||
|
}, () => {
|
||||||
|
setIcon('cross');
|
||||||
|
});
|
||||||
|
}, [value]);
|
||||||
|
const iconElement = icon === 'check' ? icons.check() : icon === 'cross' ? icons.cross() : icons.copy();
|
||||||
|
return <button className='copy-icon' title='Copy to clipboard' aria-label='Copy to clipboard' onClick={handleCopy}>{iconElement}</button>;
|
||||||
|
};
|
||||||
32
packages/extension/src/ui/icons.css
Normal file
@@ -0,0 +1,32 @@
|
|||||||
|
/*
|
||||||
|
Copyright (c) Microsoft Corporation.
|
||||||
|
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
you may not use this file except in compliance with the License.
|
||||||
|
You may obtain a copy of the License at
|
||||||
|
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
See the License for the specific language governing permissions and
|
||||||
|
limitations under the License.
|
||||||
|
*/
|
||||||
|
|
||||||
|
.octicon {
|
||||||
|
display: inline-block;
|
||||||
|
overflow: visible !important;
|
||||||
|
vertical-align: text-bottom;
|
||||||
|
fill: currentColor;
|
||||||
|
margin-right: 7px;
|
||||||
|
flex: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.color-icon-success {
|
||||||
|
color: var(--color-success-fg) !important;
|
||||||
|
}
|
||||||
|
|
||||||
|
.color-text-danger {
|
||||||
|
color: var(--color-danger-fg) !important;
|
||||||
|
}
|
||||||
49
packages/extension/src/ui/icons.tsx
Normal file
@@ -0,0 +1,49 @@
|
|||||||
|
/*
|
||||||
|
Copyright (c) Microsoft Corporation.
|
||||||
|
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
you may not use this file except in compliance with the License.
|
||||||
|
You may obtain a copy of the License at
|
||||||
|
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
See the License for the specific language governing permissions and
|
||||||
|
limitations under the License.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import './icons.css';
|
||||||
|
import './colors.css';
|
||||||
|
|
||||||
|
export const cross = () => {
|
||||||
|
return <svg className='octicon color-text-danger' viewBox='0 0 16 16' version='1.1' width='16' height='16' aria-hidden='true'>
|
||||||
|
<path fillRule='evenodd' d='M3.72 3.72a.75.75 0 011.06 0L8 6.94l3.22-3.22a.75.75 0 111.06 1.06L9.06 8l3.22 3.22a.75.75 0 11-1.06 1.06L8 9.06l-3.22 3.22a.75.75 0 01-1.06-1.06L6.94 8 3.72 4.78a.75.75 0 010-1.06z'></path>
|
||||||
|
</svg>;
|
||||||
|
};
|
||||||
|
|
||||||
|
export const check = () => {
|
||||||
|
return <svg aria-hidden='true' height='16' viewBox='0 0 16 16' version='1.1' width='16' data-view-component='true' className='octicon color-icon-success'>
|
||||||
|
<path fillRule='evenodd' d='M13.78 4.22a.75.75 0 010 1.06l-7.25 7.25a.75.75 0 01-1.06 0L2.22 9.28a.75.75 0 011.06-1.06L6 10.94l6.72-6.72a.75.75 0 011.06 0z'></path>
|
||||||
|
</svg>;
|
||||||
|
};
|
||||||
|
|
||||||
|
export const copy = () => {
|
||||||
|
return <svg className='octicon' viewBox='0 0 16 16' width='16' height='16' aria-hidden='true'>
|
||||||
|
<path d='M0 6.75C0 5.784.784 5 1.75 5h1.5a.75.75 0 0 1 0 1.5h-1.5a.25.25 0 0 0-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 0 0 .25-.25v-1.5a.75.75 0 0 1 1.5 0v1.5A1.75 1.75 0 0 1 9.25 16h-7.5A1.75 1.75 0 0 1 0 14.25Z'></path>
|
||||||
|
<path d='M5 1.75C5 .784 5.784 0 6.75 0h7.5C15.216 0 16 .784 16 1.75v7.5A1.75 1.75 0 0 1 14.25 11h-7.5A1.75 1.75 0 0 1 5 9.25Zm1.75-.25a.25.25 0 0 0-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 0 0 .25-.25v-7.5a.25.25 0 0 0-.25-.25Z'></path>
|
||||||
|
</svg>;
|
||||||
|
};
|
||||||
|
|
||||||
|
export const refresh = () => {
|
||||||
|
return <svg className='octicon' viewBox="0 0 16 16" width="16" height="16" aria-hidden='true'>
|
||||||
|
<path d="M1.705 8.005a.75.75 0 0 1 .834.656 5.5 5.5 0 0 0 9.592 2.97l-1.204-1.204a.25.25 0 0 1 .177-.427h3.646a.25.25 0 0 1 .25.25v3.646a.25.25 0 0 1-.427.177l-1.38-1.38A7.002 7.002 0 0 1 1.05 8.84a.75.75 0 0 1 .656-.834ZM8 2.5a5.487 5.487 0 0 0-4.131 1.869l1.204 1.204A.25.25 0 0 1 4.896 6H1.25A.25.25 0 0 1 1 5.75V2.104a.25.25 0 0 1 .427-.177l1.38 1.38A7.002 7.002 0 0 1 14.95 7.16a.75.75 0 0 1-1.49.178A5.5 5.5 0 0 0 8 2.5Z"></path>
|
||||||
|
</svg>;
|
||||||
|
};
|
||||||
|
|
||||||
|
export const chevronDown = () => {
|
||||||
|
return <svg className='octicon' viewBox="0 0 16 16" width="16" height="16" aria-hidden='true'>
|
||||||
|
<path d="M12.78 5.22a.749.749 0 0 1 0 1.06l-4.25 4.25a.749.749 0 0 1-1.06 0L3.22 6.28a.749.749 0 1 1 1.06-1.06L8 8.939l3.72-3.719a.749.749 0 0 1 1.06 0Z"></path>
|
||||||
|
</svg>;
|
||||||
|
};
|
||||||
@@ -19,6 +19,7 @@ import { createRoot } from 'react-dom/client';
|
|||||||
import { Button, TabItem } from './tabItem';
|
import { Button, TabItem } from './tabItem';
|
||||||
|
|
||||||
import type { TabInfo } from './tabItem';
|
import type { TabInfo } from './tabItem';
|
||||||
|
import { AuthTokenSection } from './authToken';
|
||||||
|
|
||||||
interface ConnectionStatus {
|
interface ConnectionStatus {
|
||||||
isConnected: boolean;
|
isConnected: boolean;
|
||||||
@@ -97,6 +98,7 @@ const StatusApp: React.FC = () => {
|
|||||||
No MCP clients are currently connected.
|
No MCP clients are currently connected.
|
||||||
</div>
|
</div>
|
||||||
)}
|
)}
|
||||||
|
<AuthTokenSection />
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
);
|
);
|
||||||
304
packages/extension/tests/extension.spec.ts
Normal file
@@ -0,0 +1,304 @@
|
|||||||
|
/**
|
||||||
|
* Copyright (c) Microsoft Corporation.
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import fs from 'fs';
|
||||||
|
import path from 'path';
|
||||||
|
import { chromium } from 'playwright';
|
||||||
|
import { test as base, expect } from '../../playwright-mcp/tests/fixtures';
|
||||||
|
|
||||||
|
import type { Client } from '@modelcontextprotocol/sdk/client/index.js';
|
||||||
|
import type { BrowserContext } from 'playwright';
|
||||||
|
import type { StartClient } from '../../playwright-mcp/tests/fixtures';
|
||||||
|
|
||||||
|
type BrowserWithExtension = {
|
||||||
|
userDataDir: string;
|
||||||
|
launch: (mode?: 'disable-extension') => Promise<BrowserContext>;
|
||||||
|
};
|
||||||
|
|
||||||
|
type TestFixtures = {
|
||||||
|
browserWithExtension: BrowserWithExtension,
|
||||||
|
pathToExtension: string,
|
||||||
|
useShortConnectionTimeout: (timeoutMs: number) => void
|
||||||
|
overrideProtocolVersion: (version: number) => void
|
||||||
|
};
|
||||||
|
|
||||||
|
const test = base.extend<TestFixtures>({
|
||||||
|
pathToExtension: async ({}, use) => {
|
||||||
|
await use(path.resolve(__dirname, '../dist'));
|
||||||
|
},
|
||||||
|
|
||||||
|
browserWithExtension: async ({ mcpBrowser, pathToExtension }, use, testInfo) => {
|
||||||
|
// The flags no longer work in Chrome since
|
||||||
|
// https://chromium.googlesource.com/chromium/src/+/290ed8046692651ce76088914750cb659b65fb17%5E%21/chrome/browser/extensions/extension_service.cc?pli=1#
|
||||||
|
test.skip('chromium' !== mcpBrowser, '--load-extension is not supported for official builds of Chromium');
|
||||||
|
|
||||||
|
let browserContext: BrowserContext | undefined;
|
||||||
|
const userDataDir = testInfo.outputPath('extension-user-data-dir');
|
||||||
|
await use({
|
||||||
|
userDataDir,
|
||||||
|
launch: async (mode?: 'disable-extension') => {
|
||||||
|
browserContext = await chromium.launchPersistentContext(userDataDir, {
|
||||||
|
channel: mcpBrowser,
|
||||||
|
// Opening the browser singleton only works in headed.
|
||||||
|
headless: false,
|
||||||
|
// Automation disables singleton browser process behavior, which is necessary for the extension.
|
||||||
|
ignoreDefaultArgs: ['--enable-automation'],
|
||||||
|
args: mode === 'disable-extension' ? [] : [
|
||||||
|
`--disable-extensions-except=${pathToExtension}`,
|
||||||
|
`--load-extension=${pathToExtension}`,
|
||||||
|
],
|
||||||
|
});
|
||||||
|
|
||||||
|
// for manifest v3:
|
||||||
|
let [serviceWorker] = browserContext.serviceWorkers();
|
||||||
|
if (!serviceWorker)
|
||||||
|
serviceWorker = await browserContext.waitForEvent('serviceworker');
|
||||||
|
|
||||||
|
return browserContext;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
await browserContext?.close();
|
||||||
|
},
|
||||||
|
|
||||||
|
useShortConnectionTimeout: async ({}, use) => {
|
||||||
|
await use((timeoutMs: number) => {
|
||||||
|
process.env.PWMCP_TEST_CONNECTION_TIMEOUT = timeoutMs.toString();
|
||||||
|
});
|
||||||
|
process.env.PWMCP_TEST_CONNECTION_TIMEOUT = undefined;
|
||||||
|
},
|
||||||
|
|
||||||
|
overrideProtocolVersion: async ({}, use) => {
|
||||||
|
await use((version: number) => {
|
||||||
|
process.env.PWMCP_TEST_PROTOCOL_VERSION = version.toString();
|
||||||
|
});
|
||||||
|
process.env.PWMCP_TEST_PROTOCOL_VERSION = undefined;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
async function startWithExtensionFlag(browserWithExtension: BrowserWithExtension, startClient: StartClient): Promise<Client> {
|
||||||
|
const { client } = await startClient({
|
||||||
|
args: [`--extension`],
|
||||||
|
config: {
|
||||||
|
browser: {
|
||||||
|
userDataDir: browserWithExtension.userDataDir,
|
||||||
|
}
|
||||||
|
},
|
||||||
|
});
|
||||||
|
return client;
|
||||||
|
}
|
||||||
|
|
||||||
|
const testWithOldExtensionVersion = test.extend({
|
||||||
|
pathToExtension: async ({}, use, testInfo) => {
|
||||||
|
const extensionDir = testInfo.outputPath('extension');
|
||||||
|
const oldPath = path.resolve(__dirname, '../dist');
|
||||||
|
|
||||||
|
await fs.promises.cp(oldPath, extensionDir, { recursive: true });
|
||||||
|
const manifestPath = path.join(extensionDir, 'manifest.json');
|
||||||
|
const manifest = JSON.parse(await fs.promises.readFile(manifestPath, 'utf8'));
|
||||||
|
manifest.version = '0.0.1';
|
||||||
|
await fs.promises.writeFile(manifestPath, JSON.stringify(manifest, null, 2) + '\n');
|
||||||
|
|
||||||
|
await use(extensionDir);
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
test(`navigate with extension`, async ({ browserWithExtension, startClient, server }) => {
|
||||||
|
const browserContext = await browserWithExtension.launch();
|
||||||
|
|
||||||
|
const client = await startWithExtensionFlag(browserWithExtension, startClient);
|
||||||
|
|
||||||
|
const confirmationPagePromise = browserContext.waitForEvent('page', page => {
|
||||||
|
return page.url().startsWith('chrome-extension://jakfalbnbhgkpmoaakfflhflbfpkailf/connect.html');
|
||||||
|
});
|
||||||
|
|
||||||
|
const navigateResponse = client.callTool({
|
||||||
|
name: 'browser_navigate',
|
||||||
|
arguments: { url: server.HELLO_WORLD },
|
||||||
|
});
|
||||||
|
|
||||||
|
const selectorPage = await confirmationPagePromise;
|
||||||
|
// For browser_navigate command, the UI shows Allow/Reject buttons instead of tab selector
|
||||||
|
await selectorPage.getByRole('button', { name: 'Allow' }).click();
|
||||||
|
|
||||||
|
expect(await navigateResponse).toHaveResponse({
|
||||||
|
snapshot: expect.stringContaining(`- generic [active] [ref=e1]: Hello, world!`),
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
test(`snapshot of an existing page`, async ({ browserWithExtension, startClient, server }) => {
|
||||||
|
const browserContext = await browserWithExtension.launch();
|
||||||
|
|
||||||
|
const page = await browserContext.newPage();
|
||||||
|
await page.goto(server.HELLO_WORLD);
|
||||||
|
|
||||||
|
// Another empty page.
|
||||||
|
await browserContext.newPage();
|
||||||
|
expect(browserContext.pages()).toHaveLength(3);
|
||||||
|
|
||||||
|
const client = await startWithExtensionFlag(browserWithExtension, startClient);
|
||||||
|
expect(browserContext.pages()).toHaveLength(3);
|
||||||
|
|
||||||
|
const confirmationPagePromise = browserContext.waitForEvent('page', page => {
|
||||||
|
return page.url().startsWith('chrome-extension://jakfalbnbhgkpmoaakfflhflbfpkailf/connect.html');
|
||||||
|
});
|
||||||
|
|
||||||
|
const navigateResponse = client.callTool({
|
||||||
|
name: 'browser_snapshot',
|
||||||
|
arguments: { },
|
||||||
|
});
|
||||||
|
|
||||||
|
const selectorPage = await confirmationPagePromise;
|
||||||
|
expect(browserContext.pages()).toHaveLength(4);
|
||||||
|
|
||||||
|
await selectorPage.locator('.tab-item', { hasText: 'Title' }).getByRole('button', { name: 'Connect' }).click();
|
||||||
|
|
||||||
|
expect(await navigateResponse).toHaveResponse({
|
||||||
|
snapshot: expect.stringContaining(`- generic [active] [ref=e1]: Hello, world!`),
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(browserContext.pages()).toHaveLength(4);
|
||||||
|
});
|
||||||
|
|
||||||
|
test(`extension not installed timeout`, async ({ browserWithExtension, startClient, server, useShortConnectionTimeout }) => {
|
||||||
|
useShortConnectionTimeout(100);
|
||||||
|
|
||||||
|
const browserContext = await browserWithExtension.launch();
|
||||||
|
|
||||||
|
const client = await startWithExtensionFlag(browserWithExtension, startClient);
|
||||||
|
|
||||||
|
const confirmationPagePromise = browserContext.waitForEvent('page', page => {
|
||||||
|
return page.url().startsWith('chrome-extension://jakfalbnbhgkpmoaakfflhflbfpkailf/connect.html');
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(await client.callTool({
|
||||||
|
name: 'browser_navigate',
|
||||||
|
arguments: { url: server.HELLO_WORLD },
|
||||||
|
})).toHaveResponse({
|
||||||
|
error: expect.stringContaining('Extension connection timeout. Make sure the "Playwright MCP Bridge" extension is installed.'),
|
||||||
|
isError: true,
|
||||||
|
});
|
||||||
|
|
||||||
|
await confirmationPagePromise;
|
||||||
|
});
|
||||||
|
|
||||||
|
testWithOldExtensionVersion(`works with old extension version`, async ({ browserWithExtension, startClient, server, useShortConnectionTimeout }) => {
|
||||||
|
useShortConnectionTimeout(500);
|
||||||
|
|
||||||
|
// Prelaunch the browser, so that it is properly closed after the test.
|
||||||
|
const browserContext = await browserWithExtension.launch();
|
||||||
|
|
||||||
|
const client = await startWithExtensionFlag(browserWithExtension, startClient);
|
||||||
|
|
||||||
|
const confirmationPagePromise = browserContext.waitForEvent('page', page => {
|
||||||
|
return page.url().startsWith('chrome-extension://jakfalbnbhgkpmoaakfflhflbfpkailf/connect.html');
|
||||||
|
});
|
||||||
|
|
||||||
|
const navigateResponse = client.callTool({
|
||||||
|
name: 'browser_navigate',
|
||||||
|
arguments: { url: server.HELLO_WORLD },
|
||||||
|
});
|
||||||
|
|
||||||
|
const selectorPage = await confirmationPagePromise;
|
||||||
|
// For browser_navigate command, the UI shows Allow/Reject buttons instead of tab selector
|
||||||
|
await selectorPage.getByRole('button', { name: 'Allow' }).click();
|
||||||
|
|
||||||
|
expect(await navigateResponse).toHaveResponse({
|
||||||
|
snapshot: expect.stringContaining(`- generic [active] [ref=e1]: Hello, world!`),
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
test(`extension needs update`, async ({ browserWithExtension, startClient, server, useShortConnectionTimeout, overrideProtocolVersion }) => {
|
||||||
|
useShortConnectionTimeout(500);
|
||||||
|
overrideProtocolVersion(1000);
|
||||||
|
|
||||||
|
// Prelaunch the browser, so that it is properly closed after the test.
|
||||||
|
const browserContext = await browserWithExtension.launch();
|
||||||
|
|
||||||
|
const client = await startWithExtensionFlag(browserWithExtension, startClient);
|
||||||
|
|
||||||
|
const confirmationPagePromise = browserContext.waitForEvent('page', page => {
|
||||||
|
return page.url().startsWith('chrome-extension://jakfalbnbhgkpmoaakfflhflbfpkailf/connect.html');
|
||||||
|
});
|
||||||
|
|
||||||
|
const navigateResponse = client.callTool({
|
||||||
|
name: 'browser_navigate',
|
||||||
|
arguments: { url: server.HELLO_WORLD },
|
||||||
|
});
|
||||||
|
|
||||||
|
const confirmationPage = await confirmationPagePromise;
|
||||||
|
await expect(confirmationPage.locator('.status-banner')).toContainText(`Playwright MCP version trying to connect requires newer extension version`);
|
||||||
|
|
||||||
|
expect(await navigateResponse).toHaveResponse({
|
||||||
|
error: expect.stringContaining('Extension connection timeout.'),
|
||||||
|
isError: true,
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
test(`custom executablePath`, async ({ startClient, server, useShortConnectionTimeout }) => {
|
||||||
|
useShortConnectionTimeout(1000);
|
||||||
|
|
||||||
|
const executablePath = test.info().outputPath('echo.sh');
|
||||||
|
await fs.promises.writeFile(executablePath, '#!/bin/bash\necho "Custom exec args: $@" > "$(dirname "$0")/output.txt"', { mode: 0o755 });
|
||||||
|
|
||||||
|
const { client } = await startClient({
|
||||||
|
args: [`--extension`],
|
||||||
|
config: {
|
||||||
|
browser: {
|
||||||
|
launchOptions: {
|
||||||
|
executablePath,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
const navigateResponse = await client.callTool({
|
||||||
|
name: 'browser_navigate',
|
||||||
|
arguments: { url: server.HELLO_WORLD },
|
||||||
|
});
|
||||||
|
expect(await navigateResponse).toHaveResponse({
|
||||||
|
error: expect.stringContaining('Extension connection timeout.'),
|
||||||
|
isError: true,
|
||||||
|
});
|
||||||
|
expect(await fs.promises.readFile(test.info().outputPath('output.txt'), 'utf8')).toContain('Custom exec args: chrome-extension://jakfalbnbhgkpmoaakfflhflbfpkailf/connect.html?');
|
||||||
|
});
|
||||||
|
|
||||||
|
test(`bypass connection dialog with token`, async ({ browserWithExtension, startClient, server }) => {
|
||||||
|
const browserContext = await browserWithExtension.launch();
|
||||||
|
|
||||||
|
const page = await browserContext.newPage();
|
||||||
|
await page.goto('chrome-extension://jakfalbnbhgkpmoaakfflhflbfpkailf/status.html');
|
||||||
|
const token = await page.locator('.auth-token-code').textContent();
|
||||||
|
const [name, value] = token?.split('=') || [];
|
||||||
|
|
||||||
|
const { client } = await startClient({
|
||||||
|
args: [`--extension`],
|
||||||
|
extensionToken: value,
|
||||||
|
config: {
|
||||||
|
browser: {
|
||||||
|
userDataDir: browserWithExtension.userDataDir,
|
||||||
|
}
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
const navigateResponse = await client.callTool({
|
||||||
|
name: 'browser_navigate',
|
||||||
|
arguments: { url: server.HELLO_WORLD },
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(await navigateResponse).toHaveResponse({
|
||||||
|
snapshot: expect.stringContaining(`- generic [active] [ref=e1]: Hello, world!`),
|
||||||
|
});
|
||||||
|
});
|
||||||
0
packages/playwright-cli/.gitignore
vendored
Normal file
4
packages/playwright-cli/.npmignore
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
**/*
|
||||||
|
!README.md
|
||||||
|
!LICENSE
|
||||||
|
!playwright-cli.js
|
||||||
201
packages/playwright-cli/LICENSE
Normal file
@@ -0,0 +1,201 @@
|
|||||||
|
Apache License
|
||||||
|
Version 2.0, January 2004
|
||||||
|
http://www.apache.org/licenses/
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||||
|
|
||||||
|
1. Definitions.
|
||||||
|
|
||||||
|
"License" shall mean the terms and conditions for use, reproduction,
|
||||||
|
and distribution as defined by Sections 1 through 9 of this document.
|
||||||
|
|
||||||
|
"Licensor" shall mean the copyright owner or entity authorized by
|
||||||
|
the copyright owner that is granting the License.
|
||||||
|
|
||||||
|
"Legal Entity" shall mean the union of the acting entity and all
|
||||||
|
other entities that control, are controlled by, or are under common
|
||||||
|
control with that entity. For the purposes of this definition,
|
||||||
|
"control" means (i) the power, direct or indirect, to cause the
|
||||||
|
direction or management of such entity, whether by contract or
|
||||||
|
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||||
|
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||||
|
|
||||||
|
"You" (or "Your") shall mean an individual or Legal Entity
|
||||||
|
exercising permissions granted by this License.
|
||||||
|
|
||||||
|
"Source" form shall mean the preferred form for making modifications,
|
||||||
|
including but not limited to software source code, documentation
|
||||||
|
source, and configuration files.
|
||||||
|
|
||||||
|
"Object" form shall mean any form resulting from mechanical
|
||||||
|
transformation or translation of a Source form, including but
|
||||||
|
not limited to compiled object code, generated documentation,
|
||||||
|
and conversions to other media types.
|
||||||
|
|
||||||
|
"Work" shall mean the work of authorship, whether in Source or
|
||||||
|
Object form, made available under the License, as indicated by a
|
||||||
|
copyright notice that is included in or attached to the work
|
||||||
|
(an example is provided in the Appendix below).
|
||||||
|
|
||||||
|
"Derivative Works" shall mean any work, whether in Source or Object
|
||||||
|
form, that is based on (or derived from) the Work and for which the
|
||||||
|
editorial revisions, annotations, elaborations, or other modifications
|
||||||
|
represent, as a whole, an original work of authorship. For the purposes
|
||||||
|
of this License, Derivative Works shall not include works that remain
|
||||||
|
separable from, or merely link (or bind by name) to the interfaces of,
|
||||||
|
the Work and Derivative Works thereof.
|
||||||
|
|
||||||
|
"Contribution" shall mean any work of authorship, including
|
||||||
|
the original version of the Work and any modifications or additions
|
||||||
|
to that Work or Derivative Works thereof, that is intentionally
|
||||||
|
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||||
|
or by an individual or Legal Entity authorized to submit on behalf of
|
||||||
|
the copyright owner. For the purposes of this definition, "submitted"
|
||||||
|
means any form of electronic, verbal, or written communication sent
|
||||||
|
to the Licensor or its representatives, including but not limited to
|
||||||
|
communication on electronic mailing lists, source code control systems,
|
||||||
|
and issue tracking systems that are managed by, or on behalf of, the
|
||||||
|
Licensor for the purpose of discussing and improving the Work, but
|
||||||
|
excluding communication that is conspicuously marked or otherwise
|
||||||
|
designated in writing by the copyright owner as "Not a Contribution."
|
||||||
|
|
||||||
|
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||||
|
on behalf of whom a Contribution has been received by Licensor and
|
||||||
|
subsequently incorporated within the Work.
|
||||||
|
|
||||||
|
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
copyright license to reproduce, prepare Derivative Works of,
|
||||||
|
publicly display, publicly perform, sublicense, and distribute the
|
||||||
|
Work and such Derivative Works in Source or Object form.
|
||||||
|
|
||||||
|
3. Grant of Patent License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
(except as stated in this section) patent license to make, have made,
|
||||||
|
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||||
|
where such license applies only to those patent claims licensable
|
||||||
|
by such Contributor that are necessarily infringed by their
|
||||||
|
Contribution(s) alone or by combination of their Contribution(s)
|
||||||
|
with the Work to which such Contribution(s) was submitted. If You
|
||||||
|
institute patent litigation against any entity (including a
|
||||||
|
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||||
|
or a Contribution incorporated within the Work constitutes direct
|
||||||
|
or contributory patent infringement, then any patent licenses
|
||||||
|
granted to You under this License for that Work shall terminate
|
||||||
|
as of the date such litigation is filed.
|
||||||
|
|
||||||
|
4. Redistribution. You may reproduce and distribute copies of the
|
||||||
|
Work or Derivative Works thereof in any medium, with or without
|
||||||
|
modifications, and in Source or Object form, provided that You
|
||||||
|
meet the following conditions:
|
||||||
|
|
||||||
|
(a) You must give any other recipients of the Work or
|
||||||
|
Derivative Works a copy of this License; and
|
||||||
|
|
||||||
|
(b) You must cause any modified files to carry prominent notices
|
||||||
|
stating that You changed the files; and
|
||||||
|
|
||||||
|
(c) You must retain, in the Source form of any Derivative Works
|
||||||
|
that You distribute, all copyright, patent, trademark, and
|
||||||
|
attribution notices from the Source form of the Work,
|
||||||
|
excluding those notices that do not pertain to any part of
|
||||||
|
the Derivative Works; and
|
||||||
|
|
||||||
|
(d) If the Work includes a "NOTICE" text file as part of its
|
||||||
|
distribution, then any Derivative Works that You distribute must
|
||||||
|
include a readable copy of the attribution notices contained
|
||||||
|
within such NOTICE file, excluding those notices that do not
|
||||||
|
pertain to any part of the Derivative Works, in at least one
|
||||||
|
of the following places: within a NOTICE text file distributed
|
||||||
|
as part of the Derivative Works; within the Source form or
|
||||||
|
documentation, if provided along with the Derivative Works; or,
|
||||||
|
within a display generated by the Derivative Works, if and
|
||||||
|
wherever such third-party notices normally appear. The contents
|
||||||
|
of the NOTICE file are for informational purposes only and
|
||||||
|
do not modify the License. You may add Your own attribution
|
||||||
|
notices within Derivative Works that You distribute, alongside
|
||||||
|
or as an addendum to the NOTICE text from the Work, provided
|
||||||
|
that such additional attribution notices cannot be construed
|
||||||
|
as modifying the License.
|
||||||
|
|
||||||
|
You may add Your own copyright statement to Your modifications and
|
||||||
|
may provide additional or different license terms and conditions
|
||||||
|
for use, reproduction, or distribution of Your modifications, or
|
||||||
|
for any such Derivative Works as a whole, provided Your use,
|
||||||
|
reproduction, and distribution of the Work otherwise complies with
|
||||||
|
the conditions stated in this License.
|
||||||
|
|
||||||
|
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||||
|
any Contribution intentionally submitted for inclusion in the Work
|
||||||
|
by You to the Licensor shall be under the terms and conditions of
|
||||||
|
this License, without any additional terms or conditions.
|
||||||
|
Notwithstanding the above, nothing herein shall supersede or modify
|
||||||
|
the terms of any separate license agreement you may have executed
|
||||||
|
with Licensor regarding such Contributions.
|
||||||
|
|
||||||
|
6. Trademarks. This License does not grant permission to use the trade
|
||||||
|
names, trademarks, service marks, or product names of the Licensor,
|
||||||
|
except as required for reasonable and customary use in describing the
|
||||||
|
origin of the Work and reproducing the content of the NOTICE file.
|
||||||
|
|
||||||
|
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||||
|
agreed to in writing, Licensor provides the Work (and each
|
||||||
|
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||||
|
implied, including, without limitation, any warranties or conditions
|
||||||
|
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||||
|
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||||
|
appropriateness of using or redistributing the Work and assume any
|
||||||
|
risks associated with Your exercise of permissions under this License.
|
||||||
|
|
||||||
|
8. Limitation of Liability. In no event and under no legal theory,
|
||||||
|
whether in tort (including negligence), contract, or otherwise,
|
||||||
|
unless required by applicable law (such as deliberate and grossly
|
||||||
|
negligent acts) or agreed to in writing, shall any Contributor be
|
||||||
|
liable to You for damages, including any direct, indirect, special,
|
||||||
|
incidental, or consequential damages of any character arising as a
|
||||||
|
result of this License or out of the use or inability to use the
|
||||||
|
Work (including but not limited to damages for loss of goodwill,
|
||||||
|
work stoppage, computer failure or malfunction, or any and all
|
||||||
|
other commercial damages or losses), even if such Contributor
|
||||||
|
has been advised of the possibility of such damages.
|
||||||
|
|
||||||
|
9. Accepting Warranty or Additional Liability. While redistributing
|
||||||
|
the Work or Derivative Works thereof, You may choose to offer,
|
||||||
|
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||||
|
or other liability obligations and/or rights consistent with this
|
||||||
|
License. However, in accepting such obligations, You may act only
|
||||||
|
on Your own behalf and on Your sole responsibility, not on behalf
|
||||||
|
of any other Contributor, and only if You agree to indemnify,
|
||||||
|
defend, and hold each Contributor harmless for any liability
|
||||||
|
incurred by, or claims asserted against, such Contributor by reason
|
||||||
|
of your accepting any such warranty or additional liability.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
APPENDIX: How to apply the Apache License to your work.
|
||||||
|
|
||||||
|
To apply the Apache License to your work, attach the following
|
||||||
|
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||||
|
replaced with your own identifying information. (Don't include
|
||||||
|
the brackets!) The text should be enclosed in the appropriate
|
||||||
|
comment syntax for the file format. We also recommend that a
|
||||||
|
file or class name and description of purpose be included on the
|
||||||
|
same "printed page" as the copyright notice for easier
|
||||||
|
identification within third-party archives.
|
||||||
|
|
||||||
|
Copyright (c) Microsoft Corporation.
|
||||||
|
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
you may not use this file except in compliance with the License.
|
||||||
|
You may obtain a copy of the License at
|
||||||
|
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
See the License for the specific language governing permissions and
|
||||||
|
limitations under the License.
|
||||||
391
packages/playwright-cli/README.md
Normal file
@@ -0,0 +1,391 @@
|
|||||||
|
# playwright-cli
|
||||||
|
|
||||||
|
Playwright CLI with SKILLS
|
||||||
|
|
||||||
|
### Playwright CLI vs Playwright MCP
|
||||||
|
|
||||||
|
This package provides CLI interface into Playwright. If you are using **coding agents**, that is the best fit.
|
||||||
|
|
||||||
|
- **CLI**: Modern **coding agents** increasingly favor CLI–based workflows exposed as SKILLs over MCP because CLI invocations are more token-efficient: they avoid loading large tool schemas and verbose accessibility trees into the model context, allowing agents to act through concise, purpose-built commands. This makes CLI + SKILLs better suited for high-throughput coding agents that must balance browser automation with large codebases, tests, and reasoning within limited context windows.
|
||||||
|
|
||||||
|
- **MCP**: MCP remains relevant for specialized agentic loops that benefit from persistent state, rich introspection, and iterative reasoning over page structure, such as exploratory automation, self-healing tests, or long-running autonomous workflows where maintaining continuous browser context outweighs token cost concerns. Learn more about [Playwright MCP](https://github.com/microsoft/playwright-mcp).
|
||||||
|
|
||||||
|
### Key Features
|
||||||
|
|
||||||
|
- **Token-efficient**. Does not force page data into LLM.
|
||||||
|
|
||||||
|
### Requirements
|
||||||
|
- Node.js 18 or newer
|
||||||
|
- Claude Code, GitHub Copilot, or any other coding agent.
|
||||||
|
|
||||||
|
## Getting Started
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm install -g @playwright/cli@latest
|
||||||
|
playwright-cli --help
|
||||||
|
```
|
||||||
|
|
||||||
|
## Demo
|
||||||
|
|
||||||
|
```
|
||||||
|
> Use playwright skills to test https://demo.playwright.dev/todomvc/.
|
||||||
|
Take screenshots for all successful and failing scenarios.
|
||||||
|
```
|
||||||
|
|
||||||
|
Your agent will be running commands, but it does not mean you can't play with it manually:
|
||||||
|
|
||||||
|
```
|
||||||
|
playwright-cli open https://demo.playwright.dev/todomvc/ --headed
|
||||||
|
playwright-cli type "Buy groceries"
|
||||||
|
playwright-cli press Enter
|
||||||
|
playwright-cli type "Water flowers"
|
||||||
|
playwright-cli press Enter
|
||||||
|
playwright-cli check e21
|
||||||
|
playwright-cli check e35
|
||||||
|
playwright-cli screenshot
|
||||||
|
```
|
||||||
|
|
||||||
|
### Skills-less operation
|
||||||
|
|
||||||
|
Point your agent at the CLI and let it cook. It'll read the skill off `playwright-cli --help` on its own:
|
||||||
|
|
||||||
|
```
|
||||||
|
Test the "add todo" flow on https://demo.playwright.dev/todomvc using playwright-cli.
|
||||||
|
Check playwright-cli --help for available commands.
|
||||||
|
```
|
||||||
|
|
||||||
|
### Installing skills
|
||||||
|
|
||||||
|
Claude Code, GitHub copilot and others will let you install the Playwright skills into the agentic loop.
|
||||||
|
|
||||||
|
#### plugin (recommended)
|
||||||
|
```bash
|
||||||
|
/plugin marketplace add microsoft/playwright-cli
|
||||||
|
/plugin install playwright-cli
|
||||||
|
```
|
||||||
|
|
||||||
|
#### manual
|
||||||
|
|
||||||
|
```bash
|
||||||
|
mkdir -p .claude/skills/playwright-cli
|
||||||
|
curl -o .claude/skills/playwright-cli/SKILL.md \
|
||||||
|
https://raw.githubusercontent.com/microsoft/playwright-cli/main/skills/playwright-cli/SKILL.md
|
||||||
|
```
|
||||||
|
|
||||||
|
## Headed operation
|
||||||
|
|
||||||
|
Playwright CLI is headless by default. If you'd like to see the browser, pass `--headed` to `open`:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
playwright-cli open https://playwright.dev --headed
|
||||||
|
```
|
||||||
|
|
||||||
|
## Sessions
|
||||||
|
|
||||||
|
Playwright CLI will use a dedicated persistent profile by default. It means that
|
||||||
|
your cookies and other storage state will be preserved between the calls. You can use different
|
||||||
|
instances of the browser for different projects with sessions.
|
||||||
|
|
||||||
|
Following will result in two browsers with separate profiles being available. Pass `--session` to
|
||||||
|
the invocation to talk to a specific browser.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
playwright-cli open https://playwright.dev
|
||||||
|
playwright-cli --session=example open https://example.com
|
||||||
|
playwright-cli session-list
|
||||||
|
```
|
||||||
|
|
||||||
|
You can run your coding agent with the `PLAYWRIGHT_CLI_SESSION` environment variable:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
PLAYWRIGHT_CLI_SESSION=todo-app claude .
|
||||||
|
```
|
||||||
|
|
||||||
|
Or instruct it to prepend `--session` to the calls.
|
||||||
|
|
||||||
|
Manage your sessions as follows:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
playwright-cli session-list # list all sessions
|
||||||
|
playwright-cli session-stop [name] # stop session
|
||||||
|
playwright-cli session-stop-all # stop all sessions
|
||||||
|
playwright-cli session-delete [name] # delete session data along with the profiles
|
||||||
|
```
|
||||||
|
|
||||||
|
<!-- BEGIN GENERATED CLI HELP -->
|
||||||
|
|
||||||
|
## Commands
|
||||||
|
|
||||||
|
### Core
|
||||||
|
|
||||||
|
```bash
|
||||||
|
playwright-cli open <url> # open url
|
||||||
|
playwright-cli close # close the page
|
||||||
|
playwright-cli type <text> # type text into editable element
|
||||||
|
playwright-cli click <ref> [button] # perform click on a web page
|
||||||
|
playwright-cli dblclick <ref> [button] # perform double click on a web page
|
||||||
|
playwright-cli fill <ref> <text> # fill text into editable element
|
||||||
|
playwright-cli drag <startRef> <endRef> # perform drag and drop between two elements
|
||||||
|
playwright-cli hover <ref> # hover over element on page
|
||||||
|
playwright-cli select <ref> <val> # select an option in a dropdown
|
||||||
|
playwright-cli upload <file> # upload one or multiple files
|
||||||
|
playwright-cli check <ref> # check a checkbox or radio button
|
||||||
|
playwright-cli uncheck <ref> # uncheck a checkbox or radio button
|
||||||
|
playwright-cli snapshot # capture page snapshot to obtain element ref
|
||||||
|
playwright-cli eval <func> [ref] # evaluate javascript expression on page or element
|
||||||
|
playwright-cli dialog-accept [prompt] # accept a dialog
|
||||||
|
playwright-cli dialog-dismiss # dismiss a dialog
|
||||||
|
playwright-cli resize <w> <h> # resize the browser window
|
||||||
|
```
|
||||||
|
|
||||||
|
### Navigation
|
||||||
|
|
||||||
|
```bash
|
||||||
|
playwright-cli go-back # go back to the previous page
|
||||||
|
playwright-cli go-forward # go forward to the next page
|
||||||
|
playwright-cli reload # reload the current page
|
||||||
|
```
|
||||||
|
|
||||||
|
### Keyboard
|
||||||
|
|
||||||
|
```bash
|
||||||
|
playwright-cli press <key> # press a key on the keyboard, `a`, `arrowleft`
|
||||||
|
playwright-cli keydown <key> # press a key down on the keyboard
|
||||||
|
playwright-cli keyup <key> # press a key up on the keyboard
|
||||||
|
```
|
||||||
|
|
||||||
|
### Mouse
|
||||||
|
|
||||||
|
```bash
|
||||||
|
playwright-cli mousemove <x> <y> # move mouse to a given position
|
||||||
|
playwright-cli mousedown [button] # press mouse down
|
||||||
|
playwright-cli mouseup [button] # press mouse up
|
||||||
|
playwright-cli mousewheel <dx> <dy> # scroll mouse wheel
|
||||||
|
```
|
||||||
|
|
||||||
|
### Save as
|
||||||
|
|
||||||
|
```bash
|
||||||
|
playwright-cli screenshot [ref] # screenshot of the current page or element
|
||||||
|
playwright-cli pdf # save page as pdf
|
||||||
|
```
|
||||||
|
|
||||||
|
### Tabs
|
||||||
|
|
||||||
|
```bash
|
||||||
|
playwright-cli tab-list # list all tabs
|
||||||
|
playwright-cli tab-new [url] # create a new tab
|
||||||
|
playwright-cli tab-close [index] # close a browser tab
|
||||||
|
playwright-cli tab-select <index> # select a browser tab
|
||||||
|
```
|
||||||
|
|
||||||
|
### DevTools
|
||||||
|
|
||||||
|
```bash
|
||||||
|
playwright-cli console [min-level] # list console messages
|
||||||
|
playwright-cli network # list all network requests since loading the page
|
||||||
|
playwright-cli run-code <code> # run playwright code snippet
|
||||||
|
playwright-cli tracing-start # start trace recording
|
||||||
|
playwright-cli tracing-stop # stop trace recording
|
||||||
|
```
|
||||||
|
<!-- END GENERATED CLI HELP -->
|
||||||
|
|
||||||
|
## Configuration file
|
||||||
|
|
||||||
|
The Playwright CLI can be configured using a JSON configuration file. You can specify the configuration file using the `--config` command line option:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
playwright-cli --config path/to/config.json open example.com
|
||||||
|
```
|
||||||
|
|
||||||
|
Playwright CLI will load config from `playwright-cli.json` by default so that you did not need to specify it every time.
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>Configuration file schema</summary>
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* The browser to use.
|
||||||
|
*/
|
||||||
|
browser?: {
|
||||||
|
/**
|
||||||
|
* The type of browser to use.
|
||||||
|
*/
|
||||||
|
browserName?: 'chromium' | 'firefox' | 'webkit';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Keep the browser profile in memory, do not save it to disk.
|
||||||
|
*/
|
||||||
|
isolated?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Path to a user data directory for browser profile persistence.
|
||||||
|
* Temporary directory is created by default.
|
||||||
|
*/
|
||||||
|
userDataDir?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Launch options passed to
|
||||||
|
* @see https://playwright.dev/docs/api/class-browsertype#browser-type-launch-persistent-context
|
||||||
|
*
|
||||||
|
* This is useful for settings options like `channel`, `headless`, `executablePath`, etc.
|
||||||
|
*/
|
||||||
|
launchOptions?: playwright.LaunchOptions;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Context options for the browser context.
|
||||||
|
*
|
||||||
|
* This is useful for settings options like `viewport`.
|
||||||
|
*/
|
||||||
|
contextOptions?: playwright.BrowserContextOptions;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Chrome DevTools Protocol endpoint to connect to an existing browser instance in case of Chromium family browsers.
|
||||||
|
*/
|
||||||
|
cdpEndpoint?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* CDP headers to send with the connect request.
|
||||||
|
*/
|
||||||
|
cdpHeaders?: Record<string, string>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Timeout in milliseconds for connecting to CDP endpoint. Defaults to 30000 (30 seconds). Pass 0 to disable timeout.
|
||||||
|
*/
|
||||||
|
cdpTimeout?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Remote endpoint to connect to an existing Playwright server.
|
||||||
|
*/
|
||||||
|
remoteEndpoint?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Paths to TypeScript files to add as initialization scripts for Playwright page.
|
||||||
|
*/
|
||||||
|
initPage?: string[];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Paths to JavaScript files to add as initialization scripts.
|
||||||
|
* The scripts will be evaluated in every page before any of the page's scripts.
|
||||||
|
*/
|
||||||
|
initScript?: string[];
|
||||||
|
},
|
||||||
|
|
||||||
|
/**
|
||||||
|
* If specified, saves the Playwright video of the session into the output directory.
|
||||||
|
*/
|
||||||
|
saveVideo?: {
|
||||||
|
width: number;
|
||||||
|
height: number;
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The directory to save output files.
|
||||||
|
*/
|
||||||
|
outputDir?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Whether to save snapshots, console messages, network logs and other session logs to a file or to the standard output. Defaults to "stdout".
|
||||||
|
*/
|
||||||
|
outputMode?: 'file' | 'stdout';
|
||||||
|
|
||||||
|
console?: {
|
||||||
|
/**
|
||||||
|
* The level of console messages to return. Each level includes the messages of more severe levels. Defaults to "info".
|
||||||
|
*/
|
||||||
|
level?: 'error' | 'warning' | 'info' | 'debug';
|
||||||
|
},
|
||||||
|
|
||||||
|
network?: {
|
||||||
|
/**
|
||||||
|
* List of origins to allow the browser to request. Default is to allow all. Origins matching both `allowedOrigins` and `blockedOrigins` will be blocked.
|
||||||
|
*/
|
||||||
|
allowedOrigins?: string[];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* List of origins to block the browser to request. Origins matching both `allowedOrigins` and `blockedOrigins` will be blocked.
|
||||||
|
*/
|
||||||
|
blockedOrigins?: string[];
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Specify the attribute to use for test ids, defaults to "data-testid".
|
||||||
|
*/
|
||||||
|
testIdAttribute?: string;
|
||||||
|
|
||||||
|
timeouts?: {
|
||||||
|
/*
|
||||||
|
* Configures default action timeout: https://playwright.dev/docs/api/class-page#page-set-default-timeout. Defaults to 5000ms.
|
||||||
|
*/
|
||||||
|
action?: number;
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Configures default navigation timeout: https://playwright.dev/docs/api/class-page#page-set-default-navigation-timeout. Defaults to 60000ms.
|
||||||
|
*/
|
||||||
|
navigation?: number;
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Whether to allow file uploads from anywhere on the file system.
|
||||||
|
* By default (false), file uploads are restricted to paths within the MCP roots only.
|
||||||
|
*/
|
||||||
|
allowUnrestrictedFileAccess?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Specify the language to use for code generation.
|
||||||
|
*/
|
||||||
|
codegen?: 'typescript' | 'none';
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
## Environment
|
||||||
|
|
||||||
|
| Environment |
|
||||||
|
|-------------|
|
||||||
|
| `PLAYWRIGHT_MCP_ALLOWED_HOSTS` comma-separated list of hosts this server is allowed to serve from. Defaults to the host the server is bound to. Pass '*' to disable the host check. |
|
||||||
|
| `PLAYWRIGHT_MCP_ALLOWED_ORIGINS` semicolon-separated list of TRUSTED origins to allow the browser to request. Default is to allow all. Important: *does not* serve as a security boundary and *does not* affect redirects. |
|
||||||
|
| `PLAYWRIGHT_MCP_ALLOW_UNRESTRICTED_FILE_ACCESS` allow access to files outside of the workspace roots. Also allows unrestricted access to file:// URLs. By default access to file system is restricted to workspace root directories (or cwd if no roots are configured) only, and navigation to file:// URLs is blocked. |
|
||||||
|
| `PLAYWRIGHT_MCP_BLOCKED_ORIGINS` semicolon-separated list of origins to block the browser from requesting. Blocklist is evaluated before allowlist. If used without the allowlist, requests not matching the blocklist are still allowed. Important: *does not* serve as a security boundary and *does not* affect redirects. |
|
||||||
|
| `PLAYWRIGHT_MCP_BLOCK_SERVICE_WORKERS` block service workers |
|
||||||
|
| `PLAYWRIGHT_MCP_BROWSER` browser or chrome channel to use, possible values: chrome, firefox, webkit, msedge. |
|
||||||
|
| `PLAYWRIGHT_MCP_CAPS` comma-separated list of additional capabilities to enable, possible values: vision, pdf. |
|
||||||
|
| `PLAYWRIGHT_MCP_CDP_ENDPOINT` CDP endpoint to connect to. |
|
||||||
|
| `PLAYWRIGHT_MCP_CDP_HEADER` CDP headers to send with the connect request, multiple can be specified. |
|
||||||
|
| `PLAYWRIGHT_MCP_CODEGEN` specify the language to use for code generation, possible values: "typescript", "none". Default is "typescript". |
|
||||||
|
| `PLAYWRIGHT_MCP_CONFIG` path to the configuration file. |
|
||||||
|
| `PLAYWRIGHT_MCP_CONSOLE_LEVEL` level of console messages to return: "error", "warning", "info", "debug". Each level includes the messages of more severe levels. |
|
||||||
|
| `PLAYWRIGHT_MCP_DEVICE` device to emulate, for example: "iPhone 15" |
|
||||||
|
| `PLAYWRIGHT_MCP_EXECUTABLE_PATH` path to the browser executable. |
|
||||||
|
| `PLAYWRIGHT_MCP_EXTENSION` Connect to a running browser instance (Edge/Chrome only). Requires the "Playwright MCP Bridge" browser extension to be installed. |
|
||||||
|
| `PLAYWRIGHT_MCP_GRANT_PERMISSIONS` List of permissions to grant to the browser context, for example "geolocation", "clipboard-read", "clipboard-write". |
|
||||||
|
| `PLAYWRIGHT_MCP_HEADLESS` run browser in headless mode, headed by default |
|
||||||
|
| `PLAYWRIGHT_MCP_HOST` host to bind server to. Default is localhost. Use 0.0.0.0 to bind to all interfaces. |
|
||||||
|
| `PLAYWRIGHT_MCP_IGNORE_HTTPS_ERRORS` ignore https errors |
|
||||||
|
| `PLAYWRIGHT_MCP_INIT_PAGE` path to TypeScript file to evaluate on Playwright page object |
|
||||||
|
| `PLAYWRIGHT_MCP_INIT_SCRIPT` path to JavaScript file to add as an initialization script. The script will be evaluated in every page before any of the page's scripts. Can be specified multiple times. |
|
||||||
|
| `PLAYWRIGHT_MCP_ISOLATED` keep the browser profile in memory, do not save it to disk. |
|
||||||
|
| `PLAYWRIGHT_MCP_IMAGE_RESPONSES` whether to send image responses to the client. Can be "allow" or "omit", Defaults to "allow". |
|
||||||
|
| `PLAYWRIGHT_MCP_NO_SANDBOX` disable the sandbox for all process types that are normally sandboxed. |
|
||||||
|
| `PLAYWRIGHT_MCP_OUTPUT_DIR` path to the directory for output files. |
|
||||||
|
| `PLAYWRIGHT_MCP_OUTPUT_MODE` whether to save snapshots, console messages, network logs to a file or to the standard output. Can be "file" or "stdout". Default is "stdout". |
|
||||||
|
| `PLAYWRIGHT_MCP_PORT` port to listen on for SSE transport. |
|
||||||
|
| `PLAYWRIGHT_MCP_PROXY_BYPASS` comma-separated domains to bypass proxy, for example ".com,chromium.org,.domain.com" |
|
||||||
|
| `PLAYWRIGHT_MCP_PROXY_SERVER` specify proxy server, for example "http://myproxy:3128" or "socks5://myproxy:8080" |
|
||||||
|
| `PLAYWRIGHT_MCP_SAVE_SESSION` Whether to save the Playwright MCP session into the output directory. |
|
||||||
|
| `PLAYWRIGHT_MCP_SAVE_TRACE` Whether to save the Playwright Trace of the session into the output directory. |
|
||||||
|
| `PLAYWRIGHT_MCP_SAVE_VIDEO` Whether to save the video of the session into the output directory. For example "--save-video=800x600" |
|
||||||
|
| `PLAYWRIGHT_MCP_SECRETS` path to a file containing secrets in the dotenv format |
|
||||||
|
| `PLAYWRIGHT_MCP_SHARED_BROWSER_CONTEXT` reuse the same browser context between all connected HTTP clients. |
|
||||||
|
| `PLAYWRIGHT_MCP_SNAPSHOT_MODE` when taking snapshots for responses, specifies the mode to use. Can be "incremental", "full", or "none". Default is incremental. |
|
||||||
|
| `PLAYWRIGHT_MCP_STORAGE_STATE` path to the storage state file for isolated sessions. |
|
||||||
|
| `PLAYWRIGHT_MCP_TEST_ID_ATTRIBUTE` specify the attribute to use for test ids, defaults to "data-testid" |
|
||||||
|
| `PLAYWRIGHT_MCP_TIMEOUT_ACTION` specify action timeout in milliseconds, defaults to 5000ms |
|
||||||
|
| `PLAYWRIGHT_MCP_TIMEOUT_NAVIGATION` specify navigation timeout in milliseconds, defaults to 60000ms |
|
||||||
|
| `PLAYWRIGHT_MCP_USER_AGENT` specify user agent string |
|
||||||
|
| `PLAYWRIGHT_MCP_USER_DATA_DIR` path to the user data directory. If not specified, a temporary directory will be created. |
|
||||||
|
| `PLAYWRIGHT_MCP_VIEWPORT_SIZE` specify browser viewport size in pixels, for example "1280x720" |
|
||||||
30
packages/playwright-cli/package.json
Normal file
@@ -0,0 +1,30 @@
|
|||||||
|
{
|
||||||
|
"name": "@playwright/cli",
|
||||||
|
"version": "0.0.61",
|
||||||
|
"description": "Playwright CLI",
|
||||||
|
"repository": {
|
||||||
|
"type": "git",
|
||||||
|
"url": "git+https://github.com/microsoft/playwright-cli.git"
|
||||||
|
},
|
||||||
|
"homepage": "https://playwright.dev",
|
||||||
|
"engines": {
|
||||||
|
"node": ">=18"
|
||||||
|
},
|
||||||
|
"author": {
|
||||||
|
"name": "Microsoft Corporation"
|
||||||
|
},
|
||||||
|
"license": "Apache-2.0",
|
||||||
|
"scripts": {
|
||||||
|
"lint": "echo OK",
|
||||||
|
"build": "echo OK",
|
||||||
|
"test": "echo OK"
|
||||||
|
},
|
||||||
|
"dependencies": {
|
||||||
|
"minimist": "^1.2.5",
|
||||||
|
"playwright": "1.59.0-alpha-1769452054000",
|
||||||
|
"playwright-core": "1.59.0-alpha-1769452054000"
|
||||||
|
},
|
||||||
|
"bin": {
|
||||||
|
"playwright-cli": "playwright-cli.js"
|
||||||
|
}
|
||||||
|
}
|
||||||
23
packages/playwright-cli/playwright-cli.js
Executable file
@@ -0,0 +1,23 @@
|
|||||||
|
#!/usr/bin/env node
|
||||||
|
/**
|
||||||
|
* Copyright (c) Microsoft Corporation.
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*/
|
||||||
|
|
||||||
|
const { program } = require('playwright/lib/mcp/terminal/program');
|
||||||
|
const packageJSON = require('./package.json');
|
||||||
|
program({ version: packageJSON.version }).catch(e => {
|
||||||
|
console.error(e.message);
|
||||||
|
process.exit(1);
|
||||||
|
});
|
||||||
2
packages/playwright-mcp/.gitignore
vendored
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
README.md
|
||||||
|
LICENSE
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
**/*
|
**/*
|
||||||
README.md
|
!README.md
|
||||||
LICENSE
|
!LICENSE
|
||||||
!cli.js
|
!cli.js
|
||||||
!index.*
|
!index.*
|
||||||
!config.d.ts
|
!config.d.ts
|
||||||
@@ -16,7 +16,17 @@
|
|||||||
|
|
||||||
import type * as playwright from 'playwright';
|
import type * as playwright from 'playwright';
|
||||||
|
|
||||||
export type ToolCapability = 'core' | 'core-tabs' | 'core-install' | 'vision' | 'pdf' | 'verify';
|
export type ToolCapability =
|
||||||
|
'core' |
|
||||||
|
'core-input' |
|
||||||
|
'core-navigation' |
|
||||||
|
'core-tabs' |
|
||||||
|
'core-install' |
|
||||||
|
'core-input' |
|
||||||
|
'vision' |
|
||||||
|
'pdf' |
|
||||||
|
'testing' |
|
||||||
|
'tracing';
|
||||||
|
|
||||||
export type Config = {
|
export type Config = {
|
||||||
/**
|
/**
|
||||||
@@ -64,10 +74,26 @@ export type Config = {
|
|||||||
*/
|
*/
|
||||||
cdpHeaders?: Record<string, string>;
|
cdpHeaders?: Record<string, string>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Timeout in milliseconds for connecting to CDP endpoint. Defaults to 30000 (30 seconds). Pass 0 to disable timeout.
|
||||||
|
*/
|
||||||
|
cdpTimeout?: number;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Remote endpoint to connect to an existing Playwright server.
|
* Remote endpoint to connect to an existing Playwright server.
|
||||||
*/
|
*/
|
||||||
remoteEndpoint?: string;
|
remoteEndpoint?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Paths to TypeScript files to add as initialization scripts for Playwright page.
|
||||||
|
*/
|
||||||
|
initPage?: string[];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Paths to JavaScript files to add as initialization scripts.
|
||||||
|
* The scripts will be evaluated in every page before any of the page's scripts.
|
||||||
|
*/
|
||||||
|
initScript?: string[];
|
||||||
},
|
},
|
||||||
|
|
||||||
server?: {
|
server?: {
|
||||||
@@ -80,6 +106,12 @@ export type Config = {
|
|||||||
* The host to bind the server to. Default is localhost. Use 0.0.0.0 to bind to all interfaces.
|
* The host to bind the server to. Default is localhost. Use 0.0.0.0 to bind to all interfaces.
|
||||||
*/
|
*/
|
||||||
host?: string;
|
host?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The hosts this server is allowed to serve from. Defaults to the host server is bound to.
|
||||||
|
* This is not for CORS, but rather for the DNS rebinding protection.
|
||||||
|
*/
|
||||||
|
allowedHosts?: string[];
|
||||||
},
|
},
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -100,6 +132,19 @@ export type Config = {
|
|||||||
*/
|
*/
|
||||||
saveTrace?: boolean;
|
saveTrace?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* If specified, saves the Playwright video of the session into the output directory.
|
||||||
|
*/
|
||||||
|
saveVideo?: {
|
||||||
|
width: number;
|
||||||
|
height: number;
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Reuse the same browser context between all connected HTTP clients.
|
||||||
|
*/
|
||||||
|
sharedBrowserContext?: boolean;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Secrets are used to prevent LLM from getting sensitive data while
|
* Secrets are used to prevent LLM from getting sensitive data while
|
||||||
* automating scenarios such as authentication.
|
* automating scenarios such as authentication.
|
||||||
@@ -112,6 +157,18 @@ export type Config = {
|
|||||||
*/
|
*/
|
||||||
outputDir?: string;
|
outputDir?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Whether to save snapshots, console messages, network logs and other session logs to a file or to the standard output. Defaults to "stdout".
|
||||||
|
*/
|
||||||
|
outputMode?: 'file' | 'stdout';
|
||||||
|
|
||||||
|
console?: {
|
||||||
|
/**
|
||||||
|
* The level of console messages to return. Each level includes the messages of more severe levels. Defaults to "info".
|
||||||
|
*/
|
||||||
|
level?: 'error' | 'warning' | 'info' | 'debug';
|
||||||
|
},
|
||||||
|
|
||||||
network?: {
|
network?: {
|
||||||
/**
|
/**
|
||||||
* List of origins to allow the browser to request. Default is to allow all. Origins matching both `allowedOrigins` and `blockedOrigins` will be blocked.
|
* List of origins to allow the browser to request. Default is to allow all. Origins matching both `allowedOrigins` and `blockedOrigins` will be blocked.
|
||||||
@@ -124,6 +181,11 @@ export type Config = {
|
|||||||
blockedOrigins?: string[];
|
blockedOrigins?: string[];
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Specify the attribute to use for test ids, defaults to "data-testid".
|
||||||
|
*/
|
||||||
|
testIdAttribute?: string;
|
||||||
|
|
||||||
timeouts?: {
|
timeouts?: {
|
||||||
/*
|
/*
|
||||||
* Configures default action timeout: https://playwright.dev/docs/api/class-page#page-set-default-timeout. Defaults to 5000ms.
|
* Configures default action timeout: https://playwright.dev/docs/api/class-page#page-set-default-timeout. Defaults to 5000ms.
|
||||||
@@ -140,4 +202,22 @@ export type Config = {
|
|||||||
* Whether to send image responses to the client. Can be "allow", "omit", or "auto". Defaults to "auto", which sends images if the client can display them.
|
* Whether to send image responses to the client. Can be "allow", "omit", or "auto". Defaults to "auto", which sends images if the client can display them.
|
||||||
*/
|
*/
|
||||||
imageResponses?: 'allow' | 'omit';
|
imageResponses?: 'allow' | 'omit';
|
||||||
|
|
||||||
|
snapshot?: {
|
||||||
|
/**
|
||||||
|
* When taking snapshots for responses, specifies the mode to use.
|
||||||
|
*/
|
||||||
|
mode?: 'incremental' | 'full' | 'none';
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Whether to allow file uploads from anywhere on the file system.
|
||||||
|
* By default (false), file uploads are restricted to paths within the MCP roots only.
|
||||||
|
*/
|
||||||
|
allowUnrestrictedFileAccess?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Specify the language to use for code generation.
|
||||||
|
*/
|
||||||
|
codegen?: 'typescript' | 'none';
|
||||||
};
|
};
|
||||||
43
packages/playwright-mcp/package.json
Normal file
@@ -0,0 +1,43 @@
|
|||||||
|
{
|
||||||
|
"name": "@playwright/mcp",
|
||||||
|
"version": "0.0.61",
|
||||||
|
"description": "Playwright Tools for MCP",
|
||||||
|
"repository": {
|
||||||
|
"type": "git",
|
||||||
|
"url": "git+https://github.com/microsoft/playwright-mcp.git"
|
||||||
|
},
|
||||||
|
"homepage": "https://playwright.dev",
|
||||||
|
"engines": {
|
||||||
|
"node": ">=18"
|
||||||
|
},
|
||||||
|
"author": {
|
||||||
|
"name": "Microsoft Corporation"
|
||||||
|
},
|
||||||
|
"license": "Apache-2.0",
|
||||||
|
"scripts": {
|
||||||
|
"lint": "node update-readme.js",
|
||||||
|
"test": "playwright test",
|
||||||
|
"ctest": "playwright test --project=chrome",
|
||||||
|
"ftest": "playwright test --project=firefox",
|
||||||
|
"wtest": "playwright test --project=webkit",
|
||||||
|
"dtest": "MCP_IN_DOCKER=1 playwright test --project=chromium-docker",
|
||||||
|
"build": "echo OK",
|
||||||
|
"npm-publish": "npm run lint && npm run test && npm publish",
|
||||||
|
"copy-config": "cp ../../../playwright/packages/playwright/src/mcp/config.d.ts . && perl -pi -e \"s|import type \\* as playwright from 'playwright-core';|import type * as playwright from 'playwright';|\" ./config.d.ts",
|
||||||
|
"roll": "npm run copy-config && npm run lint"
|
||||||
|
},
|
||||||
|
"exports": {
|
||||||
|
"./package.json": "./package.json",
|
||||||
|
".": {
|
||||||
|
"types": "./index.d.ts",
|
||||||
|
"default": "./index.js"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"dependencies": {
|
||||||
|
"playwright": "1.59.0-alpha-1769452054000",
|
||||||
|
"playwright-core": "1.59.0-alpha-1769452054000"
|
||||||
|
},
|
||||||
|
"bin": {
|
||||||
|
"playwright-mcp": "cli.js"
|
||||||
|
}
|
||||||
|
}
|
||||||
3
packages/playwright-mcp/src/README.md
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
# Where is the source?
|
||||||
|
|
||||||
|
Playwright MCP source code is located in the [Playwright monorepo](https://github.com/microsoft/playwright/blob/main/packages/playwright/src/mcp). Please refer to the contributor's guide in [CONTRIBUTING.md](../CONTRIBUTING.md) for more details.
|
||||||
@@ -36,37 +36,7 @@ test('test snapshot tool list', async ({ client }) => {
|
|||||||
'browser_network_requests',
|
'browser_network_requests',
|
||||||
'browser_press_key',
|
'browser_press_key',
|
||||||
'browser_resize',
|
'browser_resize',
|
||||||
'browser_snapshot',
|
'browser_run_code',
|
||||||
'browser_tabs',
|
|
||||||
'browser_take_screenshot',
|
|
||||||
'browser_wait_for',
|
|
||||||
]));
|
|
||||||
});
|
|
||||||
|
|
||||||
test('test tool list proxy mode', async ({ startClient }) => {
|
|
||||||
const { client } = await startClient({
|
|
||||||
args: ['--connect-tool'],
|
|
||||||
});
|
|
||||||
const { tools } = await client.listTools();
|
|
||||||
expect(new Set(tools.map(t => t.name))).toEqual(new Set([
|
|
||||||
'browser_click',
|
|
||||||
'browser_connect', // the extra tool
|
|
||||||
'browser_console_messages',
|
|
||||||
'browser_drag',
|
|
||||||
'browser_evaluate',
|
|
||||||
'browser_file_upload',
|
|
||||||
'browser_fill_form',
|
|
||||||
'browser_handle_dialog',
|
|
||||||
'browser_hover',
|
|
||||||
'browser_select_option',
|
|
||||||
'browser_type',
|
|
||||||
'browser_close',
|
|
||||||
'browser_install',
|
|
||||||
'browser_navigate_back',
|
|
||||||
'browser_navigate',
|
|
||||||
'browser_network_requests',
|
|
||||||
'browser_press_key',
|
|
||||||
'browser_resize',
|
|
||||||
'browser_snapshot',
|
'browser_snapshot',
|
||||||
'browser_tabs',
|
'browser_tabs',
|
||||||
'browser_take_screenshot',
|
'browser_take_screenshot',
|
||||||
@@ -16,10 +16,16 @@
|
|||||||
|
|
||||||
import { test, expect } from './fixtures';
|
import { test, expect } from './fixtures';
|
||||||
|
|
||||||
test('browser_click', async ({ client, server, mcpBrowser }) => {
|
test('browser_click', async ({ client, server }) => {
|
||||||
server.setContent('/', `
|
server.setContent('/', `
|
||||||
<title>Title</title>
|
<title>Title</title>
|
||||||
<button>Submit</button>
|
<button>Submit</button>
|
||||||
|
<script>
|
||||||
|
const button = document.querySelector('button');
|
||||||
|
button.addEventListener('click', () => {
|
||||||
|
button.focus(); // without manual focus, webkit focuses body
|
||||||
|
});
|
||||||
|
</script>
|
||||||
`, 'text/html');
|
`, 'text/html');
|
||||||
|
|
||||||
expect(await client.callTool({
|
expect(await client.callTool({
|
||||||
@@ -27,7 +33,7 @@ test('browser_click', async ({ client, server, mcpBrowser }) => {
|
|||||||
arguments: { url: server.PREFIX },
|
arguments: { url: server.PREFIX },
|
||||||
})).toHaveResponse({
|
})).toHaveResponse({
|
||||||
code: `await page.goto('${server.PREFIX}');`,
|
code: `await page.goto('${server.PREFIX}');`,
|
||||||
pageState: expect.stringContaining(`- button \"Submit\" [ref=e2]`),
|
snapshot: expect.stringContaining(`- button \"Submit\" [ref=e2]`),
|
||||||
});
|
});
|
||||||
|
|
||||||
expect(await client.callTool({
|
expect(await client.callTool({
|
||||||
@@ -38,6 +44,6 @@ test('browser_click', async ({ client, server, mcpBrowser }) => {
|
|||||||
},
|
},
|
||||||
})).toHaveResponse({
|
})).toHaveResponse({
|
||||||
code: `await page.getByRole('button', { name: 'Submit' }).click();`,
|
code: `await page.getByRole('button', { name: 'Submit' }).click();`,
|
||||||
pageState: expect.stringContaining(`- button "Submit" ${mcpBrowser !== 'webkit' || process.platform === 'linux' ? '[active] ' : ''}[ref=e2]`),
|
snapshot: expect.stringContaining(`button "Submit" [active] [ref=e2]`),
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
@@ -22,11 +22,6 @@ test('browser_navigate', async ({ client, server }) => {
|
|||||||
arguments: { url: server.HELLO_WORLD },
|
arguments: { url: server.HELLO_WORLD },
|
||||||
})).toHaveResponse({
|
})).toHaveResponse({
|
||||||
code: `await page.goto('${server.HELLO_WORLD}');`,
|
code: `await page.goto('${server.HELLO_WORLD}');`,
|
||||||
pageState: `- Page URL: ${server.HELLO_WORLD}
|
snapshot: expect.stringContaining(`generic [active] [ref=e1]: Hello, world!`),
|
||||||
- Page Title: Title
|
|
||||||
- Page Snapshot:
|
|
||||||
\`\`\`yaml
|
|
||||||
- generic [active] [ref=e1]: Hello, world!
|
|
||||||
\`\`\``,
|
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
@@ -46,6 +46,7 @@ export type StartClient = (options?: {
|
|||||||
config?: Config,
|
config?: Config,
|
||||||
roots?: { name: string, uri: string }[],
|
roots?: { name: string, uri: string }[],
|
||||||
rootsResponseDelay?: number,
|
rootsResponseDelay?: number,
|
||||||
|
extensionToken?: string,
|
||||||
}) => Promise<{ client: Client, stderr: () => string }>;
|
}) => Promise<{ client: Client, stderr: () => string }>;
|
||||||
|
|
||||||
|
|
||||||
@@ -102,7 +103,7 @@ export const test = baseTest.extend<TestFixtures & TestOptions, WorkerFixtures>(
|
|||||||
};
|
};
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
const { transport, stderr } = await createTransport(args, mcpMode, testInfo.outputPath('ms-playwright'));
|
const { transport, stderr } = await createTransport(args, mcpMode, testInfo.outputPath('ms-playwright'), options?.extensionToken);
|
||||||
let stderrBuffer = '';
|
let stderrBuffer = '';
|
||||||
stderr?.on('data', data => {
|
stderr?.on('data', data => {
|
||||||
if (process.env.PWMCP_DEBUG)
|
if (process.env.PWMCP_DEBUG)
|
||||||
@@ -181,7 +182,7 @@ export const test = baseTest.extend<TestFixtures & TestOptions, WorkerFixtures>(
|
|||||||
},
|
},
|
||||||
});
|
});
|
||||||
|
|
||||||
async function createTransport(args: string[], mcpMode: TestOptions['mcpMode'], profilesDir: string): Promise<{
|
async function createTransport(args: string[], mcpMode: TestOptions['mcpMode'], profilesDir: string, extensionToken?: string): Promise<{
|
||||||
transport: Transport,
|
transport: Transport,
|
||||||
stderr: Stream | null,
|
stderr: Stream | null,
|
||||||
}> {
|
}> {
|
||||||
@@ -208,6 +209,7 @@ async function createTransport(args: string[], mcpMode: TestOptions['mcpMode'],
|
|||||||
DEBUG_COLORS: '0',
|
DEBUG_COLORS: '0',
|
||||||
DEBUG_HIDE_DATE: '1',
|
DEBUG_HIDE_DATE: '1',
|
||||||
PWMCP_PROFILES_DIR_FOR_TEST: profilesDir,
|
PWMCP_PROFILES_DIR_FOR_TEST: profilesDir,
|
||||||
|
...(extensionToken ? { PLAYWRIGHT_MCP_EXTENSION_TOKEN: extensionToken } : {}),
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
return {
|
return {
|
||||||
@@ -227,7 +229,7 @@ export const expect = baseExpect.extend({
|
|||||||
expect(parsed).not.toEqual(expect.objectContaining(object));
|
expect(parsed).not.toEqual(expect.objectContaining(object));
|
||||||
else
|
else
|
||||||
expect(parsed).toEqual(expect.objectContaining(object));
|
expect(parsed).toEqual(expect.objectContaining(object));
|
||||||
} catch (e) {
|
} catch (e: any) {
|
||||||
return {
|
return {
|
||||||
pass: isNot,
|
pass: isNot,
|
||||||
message: () => e.message,
|
message: () => e.message,
|
||||||
@@ -248,10 +250,12 @@ function parseResponse(response: any) {
|
|||||||
const text = response.content[0].text;
|
const text = response.content[0].text;
|
||||||
const sections = parseSections(text);
|
const sections = parseSections(text);
|
||||||
|
|
||||||
|
const error = sections.get('Error');
|
||||||
const result = sections.get('Result');
|
const result = sections.get('Result');
|
||||||
const code = sections.get('Ran Playwright code');
|
const code = sections.get('Ran Playwright code');
|
||||||
const tabs = sections.get('Open tabs');
|
const tabs = sections.get('Open tabs');
|
||||||
const pageState = sections.get('Page state');
|
const pageState = sections.get('Page state');
|
||||||
|
const snapshot = sections.get('Snapshot');
|
||||||
const consoleMessages = sections.get('New console messages');
|
const consoleMessages = sections.get('New console messages');
|
||||||
const modalState = sections.get('Modal state');
|
const modalState = sections.get('Modal state');
|
||||||
const downloads = sections.get('Downloads');
|
const downloads = sections.get('Downloads');
|
||||||
@@ -260,10 +264,12 @@ function parseResponse(response: any) {
|
|||||||
const attachments = response.content.slice(1);
|
const attachments = response.content.slice(1);
|
||||||
|
|
||||||
return {
|
return {
|
||||||
|
error,
|
||||||
result,
|
result,
|
||||||
code: codeNoFrame,
|
code: codeNoFrame,
|
||||||
tabs,
|
tabs,
|
||||||
pageState,
|
pageState,
|
||||||
|
snapshot,
|
||||||
consoleMessages,
|
consoleMessages,
|
||||||
modalState,
|
modalState,
|
||||||
downloads,
|
downloads,
|
||||||
@@ -18,22 +18,31 @@
|
|||||||
|
|
||||||
const fs = require('fs')
|
const fs = require('fs')
|
||||||
const path = require('path')
|
const path = require('path')
|
||||||
const { zodToJsonSchema } = require('zod-to-json-schema')
|
|
||||||
const { execSync } = require('child_process');
|
const { execSync } = require('child_process');
|
||||||
|
|
||||||
const { allTools } = require('playwright/lib/mcp/browser/tools');
|
const { browserTools } = require('playwright/lib/mcp/browser/tools');
|
||||||
|
|
||||||
const capabilities = {
|
const capabilities = {
|
||||||
|
'core-navigation': 'Core automation',
|
||||||
'core': 'Core automation',
|
'core': 'Core automation',
|
||||||
'core-tabs': 'Tab management',
|
'core-tabs': 'Tab management',
|
||||||
|
'core-input': 'Core automation',
|
||||||
'core-install': 'Browser installation',
|
'core-install': 'Browser installation',
|
||||||
'vision': 'Coordinate-based (opt-in via --caps=vision)',
|
'vision': 'Coordinate-based (opt-in via --caps=vision)',
|
||||||
'pdf': 'PDF generation (opt-in via --caps=pdf)',
|
'pdf': 'PDF generation (opt-in via --caps=pdf)',
|
||||||
'verify': 'Verify (opt-in via --caps=verify)',
|
'testing': 'Test assertions (opt-in via --caps=testing)',
|
||||||
'tracing': 'Tracing (opt-in via --caps=tracing)',
|
'tracing': 'Tracing (opt-in via --caps=tracing)',
|
||||||
};
|
};
|
||||||
|
|
||||||
const toolsByCapability = Object.fromEntries(Object.entries(capabilities).map(([capability, title]) => [title, allTools.filter(tool => tool.capability === capability).sort((a, b) => a.schema.name.localeCompare(b.schema.name))]));
|
/** @type {Record<string, any[]>} */
|
||||||
|
const toolsByCapability = {};
|
||||||
|
for (const [capability, title] of Object.entries(capabilities)) {
|
||||||
|
let tools = browserTools.filter(tool => tool.capability === capability && !tool.skillOnly);
|
||||||
|
tools = (toolsByCapability[title] || []).concat(tools);
|
||||||
|
toolsByCapability[title] = tools;
|
||||||
|
}
|
||||||
|
for (const [, tools] of Object.entries(toolsByCapability))
|
||||||
|
tools.sort((a, b) => a.schema.name.localeCompare(b.schema.name));
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param {any} tool
|
* @param {any} tool
|
||||||
@@ -47,7 +56,7 @@ function formatToolForReadme(tool) {
|
|||||||
lines.push(` - Title: ${tool.title}`);
|
lines.push(` - Title: ${tool.title}`);
|
||||||
lines.push(` - Description: ${tool.description}`);
|
lines.push(` - Description: ${tool.description}`);
|
||||||
|
|
||||||
const inputSchema = /** @type {any} */ (zodToJsonSchema(tool.inputSchema || {}));
|
const inputSchema = /** @type {any} */ (tool.inputSchema ? tool.inputSchema.toJSONSchema() : {});
|
||||||
const requiredParams = inputSchema.required || [];
|
const requiredParams = inputSchema.required || [];
|
||||||
if (inputSchema.properties && Object.keys(inputSchema.properties).length) {
|
if (inputSchema.properties && Object.keys(inputSchema.properties).length) {
|
||||||
lines.push(` - Parameters:`);
|
lines.push(` - Parameters:`);
|
||||||
@@ -119,29 +128,102 @@ async function updateTools(content) {
|
|||||||
*/
|
*/
|
||||||
async function updateOptions(content) {
|
async function updateOptions(content) {
|
||||||
console.log('Listing options...');
|
console.log('Listing options...');
|
||||||
const output = execSync('node cli.js --help');
|
execSync('node cli.js --help > help.txt');
|
||||||
|
const output = fs.readFileSync('help.txt');
|
||||||
|
fs.unlinkSync('help.txt');
|
||||||
const lines = output.toString().split('\n');
|
const lines = output.toString().split('\n');
|
||||||
const firstLine = lines.findIndex(line => line.includes('--version'));
|
const firstLine = lines.findIndex(line => line.includes('--version'));
|
||||||
lines.splice(0, firstLine + 1);
|
lines.splice(0, firstLine + 1);
|
||||||
const lastLine = lines.findIndex(line => line.includes('--help'));
|
const lastLine = lines.findIndex(line => line.includes('--help'));
|
||||||
lines.splice(lastLine);
|
lines.splice(lastLine);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @type {{ name: string, value: string }[]}
|
||||||
|
*/
|
||||||
|
const options = [];
|
||||||
|
for (let line of lines) {
|
||||||
|
if (line.startsWith(' --')) {
|
||||||
|
const l = line.substring(' --'.length);
|
||||||
|
const gapIndex = l.indexOf(' ');
|
||||||
|
const name = l.substring(0, gapIndex).trim();
|
||||||
|
const value = l.substring(gapIndex).trim();
|
||||||
|
options.push({ name, value });
|
||||||
|
} else {
|
||||||
|
const value = line.trim();
|
||||||
|
options[options.length - 1].value += ' ' + value;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const table = [];
|
||||||
|
table.push(`| Option | Description |`);
|
||||||
|
table.push(`|--------|-------------|`);
|
||||||
|
for (const option of options) {
|
||||||
|
const prefix = option.name.split(' ')[0];
|
||||||
|
const envName = `PLAYWRIGHT_MCP_` + prefix.toUpperCase().replace(/-/g, '_');
|
||||||
|
table.push(`| --${option.name} | ${option.value}<br>*env* \`${envName}\` |`);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (process.env.PRINT_ENV) {
|
||||||
|
const envTable = [];
|
||||||
|
envTable.push(`| Environment |`);
|
||||||
|
envTable.push(`|-------------|`);
|
||||||
|
for (const option of options) {
|
||||||
|
const prefix = option.name.split(' ')[0];
|
||||||
|
const envName = `PLAYWRIGHT_MCP_` + prefix.toUpperCase().replace(/-/g, '_');
|
||||||
|
envTable.push(`| \`${envName}\` ${option.value} |`);
|
||||||
|
}
|
||||||
|
console.log(envTable.join('\n'));
|
||||||
|
}
|
||||||
|
|
||||||
const startMarker = `<!--- Options generated by ${path.basename(__filename)} -->`;
|
const startMarker = `<!--- Options generated by ${path.basename(__filename)} -->`;
|
||||||
const endMarker = `<!--- End of options generated section -->`;
|
const endMarker = `<!--- End of options generated section -->`;
|
||||||
|
return updateSection(content, startMarker, endMarker, table);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {string} content
|
||||||
|
* @returns {Promise<string>}
|
||||||
|
*/
|
||||||
|
async function updateConfig(content) {
|
||||||
|
console.log('Updating config schema from config.d.ts...');
|
||||||
|
const configPath = path.join(__dirname, 'config.d.ts');
|
||||||
|
const configContent = await fs.promises.readFile(configPath, 'utf-8');
|
||||||
|
|
||||||
|
// Extract the Config type definition
|
||||||
|
const configTypeMatch = configContent.match(/export type Config = (\{[\s\S]*?\n\});/);
|
||||||
|
if (!configTypeMatch)
|
||||||
|
throw new Error('Config type not found in config.d.ts');
|
||||||
|
|
||||||
|
const configType = configTypeMatch[1]; // Use capture group to get just the object definition
|
||||||
|
|
||||||
|
const startMarker = `<!--- Config generated by ${path.basename(__filename)} -->`;
|
||||||
|
const endMarker = `<!--- End of config generated section -->`;
|
||||||
return updateSection(content, startMarker, endMarker, [
|
return updateSection(content, startMarker, endMarker, [
|
||||||
'```',
|
'```typescript',
|
||||||
'> npx @playwright/mcp@latest --help',
|
configType,
|
||||||
...lines,
|
|
||||||
'```',
|
'```',
|
||||||
]);
|
]);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {string} filePath
|
||||||
|
*/
|
||||||
|
async function copyToPackage(filePath) {
|
||||||
|
await fs.promises.copyFile(path.join(__dirname, '../../', filePath), path.join(__dirname, filePath));
|
||||||
|
console.log(`${filePath} copied successfully`);
|
||||||
|
}
|
||||||
|
|
||||||
async function updateReadme() {
|
async function updateReadme() {
|
||||||
const readmePath = path.join(__dirname, 'README.md');
|
const readmePath = path.join(__dirname, '../../README.md');
|
||||||
const readmeContent = await fs.promises.readFile(readmePath, 'utf-8');
|
const readmeContent = await fs.promises.readFile(readmePath, 'utf-8');
|
||||||
const withTools = await updateTools(readmeContent);
|
const withTools = await updateTools(readmeContent);
|
||||||
const withOptions = await updateOptions(withTools);
|
const withOptions = await updateOptions(withTools);
|
||||||
await fs.promises.writeFile(readmePath, withOptions, 'utf-8');
|
const withConfig = await updateConfig(withOptions);
|
||||||
|
await fs.promises.writeFile(readmePath, withConfig, 'utf-8');
|
||||||
console.log('README updated successfully');
|
console.log('README updated successfully');
|
||||||
|
|
||||||
|
await copyToPackage('README.md');
|
||||||
|
await copyToPackage('LICENSE');
|
||||||
}
|
}
|
||||||
|
|
||||||
updateReadme().catch(err => {
|
updateReadme().catch(err => {
|
||||||
@@ -1,3 +0,0 @@
|
|||||||
# Where is the source?
|
|
||||||
|
|
||||||
Playwright MCP source code is located in the Playwright monorepo. Please refer to the contributor's guide in [CONTRIBUTING.md](../CONTRIBUTING.md) for more details.
|
|
||||||