AI Agent Integration

Connect to OpenBook

Three ways to give your AI assistant direct access to OpenBook's real-world data

Method 1: MCP Server

For Claude Desktop, Cursor, Cherry Studio, Windsurf, and all MCP clients

1

Add the following config in your MCP client settings

mcpServers.json
{
  "mcpServers": {
    "openbook": {
      "url": "https://openbook.now/api/mcp"
    }
  }
}
2

Restart the client, then use these 5 tools

search_signals

Search signals by city, category, type, keyword

params: city, category, signal_type, keyword

get_signal_detail

Get full details of a single signal

params: signal_id

submit_signal

Submit a new signal with structured data

params: city, category, title, content, ...

submit_signal_text

Submit signal via natural language (AI auto-extracts)

params: text

list_cities

List covered cities and signal counts

params: none

Method 2: WorkBuddy / OpenClaw Skill

For WeChat AI assistants: WorkBuddy, OpenClaw, QClaw, KimiClaw

1

Download the Skill package

2

Unzip and import into your AI client

WorkBuddy

Open WorkBuddy → Skills → Import Skill → Select the unzipped openbook folder

Or manually copy to: C:\Users\YourName\.workbuddy\skills\

OpenClaw / QClaw

Copy the openbook folder to ~/.openclaw/skills/

3

Use directly in WeChat

Type @openbook followed by your question, AI will automatically query OpenBook:

@openbookWhich apartments in Beijing have good soundproofing?
@openbookAny tips for renting in Pudong, Shanghai?
@openbookWhat food is recommended in Hangzhou?

Method 3: HTTP API

For developers integrating into GPT Actions, Dify, Coze, etc.

Smart Search (Recommended)

signals.smartSearch
GET https://openbook.now/api/trpc/signals.smartSearch?input={"json":{"query":"北京隔音好的小区"}}

Accepts natural language queries, auto-detects city, category, and keywords

Structured Query

signals.query
GET https://openbook.now/api/trpc/signals.query?input={"json":{"city":"Beijing","category":"housing","keyword":"soundproofing"}}

Optional params: city, category (housing/food/jobs), signal_type (recommendation/warning/neutral/tip), keyword

Response Format

Response JSON
{
  "result": {
    "data": {
      "json": {
        "signals": [
          {
            "id": "bj-housing-001",
            "title": "万柳书院 隔音评价",
            "city": "Beijing",
            "category": "housing",
            "signal_type": "recommendation",
            "content": "双层楼板+专业隔音垫,隔音极佳",
            "tags": ["soundproofing", "haidian"],
            "date": "2025-03-15"
          }
        ],
        "total": 42
      }
    }
  }
}

Try It

Try these queries in your AI client

Which apartments in Beijing have good soundproofing?
Any tips for renting in Pudong, Shanghai?
What food is recommended in Hangzhou?
I want to share: XX apartment in Chaoyang has bad soundproofing
Which cities does OpenBook cover?