- Home
- MCP servers
- Promptz
Promptz
- typescript
4
GitHub Stars
typescript
Language
6 months ago
First Indexed
2 months ago
Catalog Refreshed
Documentation & install
Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.
Installation
Add the following to your MCP client configuration file.
Configuration
View docs{
"mcpServers": {
"cremich-promptz-mcp": {
"command": "npx",
"args": [
"-y",
"@promptz/mcp"
],
"env": {
"PROMPTZ_API_KEY": "your-api-key-from-promptz.dev",
"PROMPTZ_API_URL": "your-api-url-from-promptz.dev"
}
}
}
}You can access prompts and project rules from promptz.dev directly inside your MCP workflow. This MCP Server lets you query prompts and rules without leaving your development environment, reducing context switching and speeding up how you work with promptz.dev data.
How to use
Connect the promptz.dev MCP Server to your MCP client, then interact with prompts and rules using natural language in your editor or IDE. You can search for prompts by topic, open a prompt to review its details, or run a prompt to generate or modify content. You can also search for project rules and add or update them in your workspace through supported executable functions. Use simple phrases like “Search for CLI prompts about JavaScript,” “Show me the prompt called ‘React Component Documentation’,” or “Find project rules for CDK Development.” When you find a rule you want to apply, you can add it to your workspace for quick reuse.
How to install
Prerequisites you need before installing the MCP Server are Node.js and npm, plus access to your MCP client configuration. Ensure you can modify or write to your MCP client settings file at the path shown in your environment.
Step 1 Get API Credentials. You will obtain API details from the service you are connecting to.
Step 2 Install the MCP Server. You have two installation options described below. Choose the one that fits your workflow.
{
"mcpServers": {
"promptz.dev": {
"command": "npx",
"args": ["-y", "@promptz/mcp"],
"env": {
"PROMPTZ_API_URL": "your-api-url-from-promptz.dev",
"PROMPTZ_API_KEY": "your-api-key-from-promptz.dev"
},
"disabled": false,
"autoApprove": []
}
}
}
{
"mcpServers": {
"promptz.dev": {
"command": "node",
"args": ["/path/to/promptz-mcp/build/index.js"],
"env": {
"PROMPTZ_API_URL": "your-api-url-from-promptz.dev",
"PROMPTZ_API_KEY": "your-api-key-from-promptz.dev"
},
"disabled": false,
"autoApprove": []
}
}
}
Troubleshooting
If you run into issues with the server, verify your API credentials, ensure the MCP client is configured correctly, and review logs for errors. Look for log files at your home directory under the promptz path and use debugging tools to inspect the MCP setup.
# Run with environment variables to inspect the inspector
PROMPTZ_API_URL="your-api-url" PROMPTZ_API_KEY="your-api-key" npm run inspector
Development
If you want to contribute or modify the server, you can install dependencies, build, and run tests locally.
# Install dependencies
npm install
# Build the server
npm run build
# For development with auto-rebuild
npm run watch
# Run tests
npm test
Security Considerations
The MCP Server provides read access to prompts and rules only. Your API credentials are stored in your MCP client configuration, and all communication with the promptz.dev API uses HTTPS. Logs are written to your local home directory for auditing and debugging.
Available tools
prompts
Executable functions to search and execute prompts from promptz.dev within your MCP client.
rules
Executable functions to search for project rules and integrate or update them in your workspace.