@bitwarden/mcp-server

中文文档
2026.7.0发布于 2026/07/08SEE LICENSE IN LICENSE.txtES Module近 30 天下载 9434

Bitwarden MCP Server

原始使用文档
文档目录25 节
  1. What is MCP?
  2. Features
  3. Vault Management and CLI tools (CLI)
  4. Organization Administration (API)
  5. Quick Start
  6. Prerequisites
  7. Configuration
  8. Environment Variables
  9. Usage Examples
  10. Available Tools
  11. Vault Management and CLI Tools
  12. Organization Administration
  13. Development
  14. Setup
  15. Commands
  16. Testing with MCP Inspector
  17. Best Practices
  18. Testing
  19. Debugging
  20. Security Considerations
  21. Troubleshooting
  22. CLI Issues
  23. Unlocking the vault interactively
  24. API Issues
  25. Contributing

Bitwarden MCP Server

A Model Context Protocol (MCP) server that provides AI assistants with secure access to Bitwarden password manager functionality through two complementary interfaces:

  • Vault Management and CLI tools via Bitwarden CLI
  • Organization Administration via Bitwarden Public API

npm version

[!WARNING] This MCP server is designed exclusively for local use and must never be hosted publicly or exposed over a network.

When you grant an AI assistant access to this server, you are providing the ability to:

  • Read vault items including passwords, secure notes, and sensitive data
  • Create, modify, and delete vault items
  • Access organization secrets and administrative functions
  • Expose credentials and vault contents through AI responses

You are responsible for:

  • Ensuring this server runs only on your local machine or self-hosted environment
  • Understanding what data you're exposing to your AI assistant
  • Being aware that AI responses may inadvertently reveal sensitive information
  • Using appropriate AI providers (consider self-hosted or local LLMs for sensitive data)
  • Never sharing configuration files containing session tokens or API credentials
  • Monitoring logs for unexpected activity

Never:

  • Deploy this server to cloud hosting, containers, or public servers
  • Share your MCP configuration files with others
  • Use this server over untrusted networks
  • Grant access to untrusted AI clients or services

Use this tool responsibly and at your own risk.

What is MCP?

The Model Context Protocol is an open standard that enables AI assistants to securely interact with local tools and services. This server exposes Bitwarden's vault management and organization administration capabilities to MCP-compatible AI clients like Claude Desktop.

Features

Vault Management and CLI tools (CLI)

  • Session Management: Unlock vault via native OS password dialog, lock vault, sync with server, check status
  • Item Operations: List, retrieve, create, edit, delete, restore vault items
    • Supports logins, secure notes, cards, and identities
    • Advanced filtering by URL, folder, collection, or trash status
  • Folder Management: Organize items with folders
  • Attachments: Upload, download, and manage file attachments
  • Password Tools: Generate secure passwords and retrieve TOTP codes
  • Bitwarden Send: Create and manage secure ephemeral shares (text/file)
  • Organization Items: Move items to organizations, manage collections
  • Device Approval: Approve or deny new device login requests
  • Member Management: Confirm organization member registrations

Organization Administration (API)

  • Collections: Create, update, delete, and manage collection permissions
  • Members: Invite, update roles, remove members, manage group assignments
  • Groups: Create role-based access groups and assign members
  • Policies: Configure and enforce organization security policies
  • Audit Logs: Retrieve organization event history
  • Subscriptions: View and update organization billing information
  • Bulk Import: Import users and groups from external systems

Quick Start

Prerequisites

For Vault Management and CLI tools:

  • Bitwarden CLI installed (ex. npm install -g @bitwarden/cli)
  • Node.js 22+
  • Bitwarden account

For Organization Administration:

  • Node.js 22+
  • Bitwarden Teams or Enterprise organization
  • Organization owner or admin permissions

Configuration

[!WARNING] The configuration files below will contain sensitive credentials that grant access to your Bitwarden vault. Keep these files secure, never commit them to version control, and never share them with others. Ensure your MCP client (e.g., Claude Desktop) is configured to run the server locally only.

Add to your Claude Desktop configuration file:

  • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
  • Windows: %APPDATA%\Claude\claude_desktop_config.json
{
  "mcpServers": {
    "bitwarden": {
      "command": "npx",
      "args": ["-y", "@bitwarden/mcp-server"],
      "env": {
        "BW_SESSION": "your-session-token-here"
      }
    }
  }
}

Get your session token:

bw login
bw unlock --raw

To enable organization administration features, add API credentials:

{
  "mcpServers": {
    "bitwarden": {
      "command": "npx",
      "args": ["-y", "@bitwarden/mcp-server"],
      "env": {
        "BW_SESSION": "your-session-token-here",
        "BW_CLIENT_ID": "organization.your-client-id",
        "BW_CLIENT_SECRET": "your-client-secret"
      }
    }
  }
}

Get organization API credentials:

  1. Go to your Bitwarden Web Vault
  2. Navigate to your organization → Settings → My Organization
  3. Scroll to "API Key" section
  4. Click "View API Key" and authenticate

Option 2: Locally Built and Referenced

Requires that this repository be checked out locally. Once that's done:

npm install
npm run build

Then reference the built dist/index.js file from Claude desktop:

{
  "mcpServers": {
    "bitwarden": {
      "command": "node",
      "args": ["local/path/to/mcp-server/dist/index.js"],
      "env": {
        "BW_SESSION": "your-session-token-here"
      }
    }
  }
}

Option 3: Other MCP Clients

Any MCP-compatible client can connect to this server via stdio transport. Refer to your client's documentation for configuration details.

Environment Variables

VariableRequired ForDescriptionDefault
BW_SESSIONCLI operationsSession token from bw unlock --raw-
BW_CLIENT_IDAPI operationsOrganization API client ID-
BW_CLIENT_SECRETAPI operationsOrganization API client secret-
BW_API_BASE_URLAPI operationsBitwarden API base URLhttps://api.bitwarden.com
BW_IDENTITY_URLAPI operationsOAuth2 identity server URLhttps://identity.bitwarden.com
BW_ALLOWED_DIRECTORIESFile operationsComma-separated list of allowed file directories. Required for file-based tools (e.g. create_file_send, create_attachment); when unset, all file operations are rejected.-
BW_CLI_PATHCLI operationsAbsolute path to the bw executable or its JS entry point. Only needed when the CLI cannot be auto-located on PATH (e.g. it is not on PATH, or a non-standard global install layout).auto-resolved from PATH

Note: For self-hosted Bitwarden instances, set BW_API_BASE_URL and BW_IDENTITY_URL to your server URLs.

Note: BW_CLIENT_ID and BW_CLIENT_SECRET are the environment variable names read by the MCP server. If you are using bw login --apikey in a startup script, the Bitwarden CLI reads BW_CLIENTID and BW_CLIENTSECRET (no underscores between words) for the same credentials. See the Bitwarden CLI documentation.

Usage Examples

Once configured, you can interact with Bitwarden through your AI assistant:

Vault:

  • "List all my login items"
  • "Get my credentials for github"
  • "Create a new secure note for my home WiFi information"
  • "Generate a 32-character password and save it for apple.com"
  • "Create a Send link for this file"

Organization Administration:

  • "List all members in my organization"
  • "Invite [email protected] as an organization admin"
  • "Create a 'Development Team' collection"
  • "Show me the last 100 audit log events"
  • "What security policies are enabled?"

Available Tools

Vault Management and CLI Tools

  • Session: lock, unlock, sync, status
  • Retrieval: list, get
  • Items: create_item, edit_item, delete, restore
  • Folders: create_folder, edit_folder
  • Attachments: create_attachment
  • Organizations: create_org_collection, edit_org_collection, edit_item_collections, move, confirm
  • Device Approval: device_approval_list, device_approval_approve, device_approval_approve_all, device_approval_deny, device_approval_deny_all
  • Send: create_text_send, create_file_send, list_send, get_send, edit_send, delete_send, remove_send_password
  • Utilities: generate

Organization Administration

  • Collections: list_org_collections, get_org_collection, update_org_collection, delete_org_collection
  • Members: list_org_members, get_org_member, invite_org_member, update_org_member, remove_org_member, reinvite_org_member, get_org_member_groups, update_org_member_groups
  • Groups: list_org_groups, get_org_group, create_org_group, update_org_group, delete_org_group, get_org_group_members, update_org_group_members
  • Policies: list_org_policies, get_org_policy, update_org_policy
  • Events: get_org_events
  • Subscriptions: get_org_subscription, update_org_subscription
  • Import: import_org_users_and_groups

Development

Setup

git clone https://github.com/bitwarden/mcp-server.git
cd mcp-server
npm install

Commands

npm run build        # Compile TypeScript
npm test             # Run test suite
npm run lint         # Check code style
npm run lint:fix     # Auto-fix linting issues
npm run inspect      # Test with MCP Inspector

Testing with MCP Inspector

The MCP Inspector provides an interactive testing environment:

npm run build
npm run inspect

This opens a web interface where you can:

  • Browse available tools
  • Test tool execution with custom inputs
  • View request/response payloads
  • Debug tool behavior

Best Practices

  • Store credentials securely (use system keychains or environment managers)
  • Rotate session tokens regularly
  • Review audit logs periodically for suspicious activity
  • Never commit credentials to version control

Testing

The project includes Jest unit tests covering validation, CLI commands, and core functionality.

# Run all tests
npm test

# Run tests in watch mode
npm run test:watch

# Run tests with coverage
npm test -- --coverage

# Run specific test file
npm test validation.spec.ts

# Run tests matching a pattern
npm test -- --testNamePattern="validation"

Debugging

Enable debug logging by setting environment variables:

export DEBUG=bitwarden:*
export NODE_ENV=development

Security Considerations

  • Never commit sensitive credentials (BW_SESSION, BW_CLIENT_ID, BW_CLIENT_SECRET)
  • Use environment variables for all sensitive configuration
  • Validate all inputs using Zod schemas (already implemented)
  • Test with non-production data when possible
  • Monitor API usage through your organization's audit logs
  • Understand the security and privacy impacts of exposing sensitive vault data to LLM and AI tools. Using a self-hosted or local LLM may be appropriate, for example.

Troubleshooting

CLI Issues

  • Vault is locked

    • Ask your AI assistant to run the unlock tool — the MCP server will open a native OS password dialog for you to enter your master password. The password is never sent through the MCP protocol or seen by the LLM.

    • On headless machines (no DISPLAY on Linux, no GUI session), the unlock tool will refuse to run. Use the manual fallback:

      bw unlock --raw
      # Copy the token and update BW_SESSION in your MCP config
      
  • Session key is invalid

    • Session tokens expire after inactivity
    • Ask your AI assistant to run the unlock tool to refresh the session in-place, or run bw unlock --raw manually and update your MCP configuration with the new token

Unlocking the vault interactively

The unlock tool lets your AI assistant prompt you for your master password without that password ever crossing the MCP channel.

  • The tool takes no input parameters. It cannot be invoked with a password argument.
  • When called, the server launches a native OS password dialog:
    • macOS: osascript secure input dialog
    • Linux: zenity --password (falls back to kdialog --password)
    • Windows: PowerShell WinForms password dialog (masked input)
  • The password is passed to bw unlock --raw via the --passwordenv flag with a randomized one-shot environment variable. It never appears in process arguments, in the MCP protocol, or in the LLM's context.
  • The LLM only ever sees "Vault unlocked successfully." or a sanitized failure message (e.g. "Invalid master password.", "Unlock cancelled.").
  • If you are in a non-interactive environment, the tool will refuse to run and return a fixed message directing you to the bw unlock --raw manual flow.

API Issues

  • Invalid client credentials

    • Verify BW_CLIENT_ID starts with organization.
    • Ensure BW_CLIENT_SECRET is correct
    • Check that API keys haven't been rotated in the Admin Console
  • 403 Forbidden

    • Verify you have organization owner or admin permissions
    • Some operations require specific roles (e.g., managing members)

Contributing

We welcome contributions! Please see CONTRIBUTING.md for guidelines.

版本与发布记录

@bitwarden/mcp-server 共发布 18 个版本,首次发布于 2025/07/10;过去 12 个月发布了 5 个版本。

版本发布日期距今
2026.7.0latest2026/07/084 个月前
2026.5.12026/05/285 个月前
2026.5.02026/05/215 个月前
2026.2.02026/02/198 个月前
2026.1.02026/01/089 个月前
2025.10.42025/10/291 年前

关于 @bitwarden/mcp-server 的常见问题

@bitwarden/mcp-server 是什么?

Bitwarden MCP Server

如何安装 @bitwarden/mcp-server?

在项目目录运行 npm install @bitwarden/mcp-server,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 mcp-server-bitwarden,可以用 npx mcp-server-bitwarden 直接运行。

@bitwarden/mcp-server 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/bitwarden__mcp-server 是否存在。

@bitwarden/mcp-server 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@bitwarden/mcp-server 可以商用吗?

@bitwarden/mcp-server 使用 SEE LICENSE IN LICENSE.txt 许可。许可条款写在包内的独立文件中,请阅读该文件确认可否商用。以上为概括,不构成法律意见,请以许可原文为准。

@bitwarden/mcp-server 的下载量有多少?

根据 npm 官方下载统计,@bitwarden/mcp-server 在 2026/10/08 – 2026/11/06 这 30 天内被下载 9,434 次,日均约 314 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@bitwarden/mcp-server 还在维护吗?

最新版本 2026.7.0 发布于 2026/07/08(4 个月前);至今共发布 18 个版本,其中过去 12 个月发布了 5 个;首次发布于 2025/07/10。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。