0.0.1 • Published 4 months ago

agentql-mcp-server v0.0.1

Weekly downloads
-
License
MIT
Repository
github
Last release
4 months ago

AgentQL MCP Server

This is a TypeScript-based MCP server that implements triggering AgentQL REST API.

Features

Tools

  • extract-web-data - extract structured data from a given 'url', using 'prompt' as a description of actual data and its fields to extract.

Installation

To use with Claude Desktop, add the server config to Claude config:

On MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json On Windows: %APPDATA%/Claude/claude_desktop_config.json

  1. Install the package from NPM registry:

    npm install -g agentql-mcp-server
  2. Add agentql plugin config inside mcpServers dict in claude_desktop_config.json file (don't forget to provide actual API key) and restart the app:

    {
      "mcpServers": {
        "agentql": {
          "command": "npx",
          "args": [
            "-y",
            "agentql-mcp-server"
          ],
          "env": {
            "AGENTQL_API_KEY": "YOUR_API_KEY"
          }
        }
      }
    }

For Dev Version

For dev version the config content will change to refer to the work in progress code:

{
  "mcpServers": {
    "agentql": {
      "command": "/path/to/aql-server/js/build/index.js",
      "env": {
        "AGENTQL_API_KEY": "YOUR_API_KEY"
      }
    }
  }
}

Validate

After restarting the app check the bottom right corner of the user message input area. It should show MCP tools button which you need to click:

MCP Tools Button

The opened dialog should show newly added extract-web-data tool in hte list, among the other tools from other plugin servers:

Available MCP Tools

Now you can give Claude a task that will be able to use newly added tool. For example:

Extract the main video info from this page https://www.youtube.com/watch?v=7kbQnLN2y_I. Make sure it has title, author name, number of views and likes.

AQL Tool Execution

!TIP In case Claude complains that it can't open urls or load content from the web instead of usign AgentQL, try adding "use tools" or "use agentql tool" hint.

Development

Install dependencies:

npm install

Build the server:

npm run build

For development with auto-rebuild:

npm run watch

Debugging

Since MCP servers communicate over stdio, debugging can be challenging. We recommend using the MCP Inspector, which is available as a package script:

npm run inspector

The Inspector will provide a URL to access debugging tools in your browser.