Skip to content

Commit d5f79b7

Browse files
Update README with mcp information
1 parent c2eda41 commit d5f79b7

File tree

1 file changed

+47
-8
lines changed

1 file changed

+47
-8
lines changed

README.md

Lines changed: 47 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -50,23 +50,62 @@ bundle exec jekyll serve
5050

5151
## MCP Server
5252

53-
This repository includes an MCP (Model Context Protocol) server that provides programmatic access to the Drupal tools database. See [mcp-server/README.md](./mcp-server/README.md) for details.
53+
This repository includes an MCP (Model Context Protocol) server that provides programmatic access to the Drupal tools database. The MCP server enables AI assistants like Claude Desktop to intelligently discover and recommend Drupal development tools through natural language queries.
5454

55-
### Quick Start
55+
### Two Ways to Use
56+
57+
#### Option 1: NPM Package (Recommended for End Users)
58+
59+
Install the published NPM package for immediate use with Claude Desktop:
60+
61+
```bash
62+
# Add to Claude Desktop configuration:
63+
# "mcpServers": {
64+
# "drupaltools": {
65+
# "type": "stdio",
66+
# "command": "npx",
67+
# "args": ["@drupaltools/mcp@latest"]
68+
# }
69+
# }
70+
```
71+
72+
Then you can ask Claude things like:
73+
74+
- "Show me 5 tools for testing Drupal sites"
75+
- "Search for Docker-based Drupal development tools"
76+
- "Tell me about BLT (Acquia Lightning) tool"
77+
78+
**Package name:** `@drupaltools/mcp`
79+
**Repository:** [mcp-package/](./mcp-package/)
80+
**Documentation:** [mcp-package/README.md](./mcp-package/README.md)
81+
82+
#### Option 2: Development Server (For Contributors)
83+
84+
Run locally from source for testing and development:
5685

5786
```bash
5887
npm install
5988
npm run mcp
6089
```
6190

62-
The MCP server provides three tools:
63-
- `list_tools`: List all tools with optional category filtering
64-
- `search_tools`: Semantic search for tools
65-
- `get_tool`: Get detailed information about a specific tool
91+
**Repository:** [mcp-server/](./mcp-server/)
92+
**Documentation:** [mcp-server/README.md](./mcp-server/README.md)
93+
94+
### Demo & Testing
95+
96+
Visit the demo page: [/mcp-server/](./mcp-server/index.html)
6697

67-
Or just open in Gitpod!
98+
Or test with MCP Inspector:
99+
```bash
100+
npx @modelcontextprotocol/inspector node mcp-server/index.js
101+
```
68102

69-
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/drupaltools/drupaltools.github.io)
103+
### Available Tools
104+
105+
The MCP server provides three tools:
106+
- **`list_tools`**: List all tools with optional category filtering
107+
- **`search_tools`**: Semantic search for tools using intelligent scoring
108+
- **`get_tool`**: Get detailed information about a specific tool
70109

71110
## Similar tools
72111

0 commit comments

Comments
 (0)