|
| 1 | +--- |
| 2 | +title: MCP Server |
| 3 | +description: Reference for all everyrow MCP server tools — async operations with progress polling and result retrieval. |
| 4 | +--- |
| 5 | + |
| 6 | +# MCP Server Reference |
| 7 | + |
| 8 | +The everyrow MCP server exposes tools for AI-powered data processing. These tools are called directly by Claude Code, Codex CLI, and other MCP clients — no Python code is needed. |
| 9 | + |
| 10 | +All operations use an async pattern: submit the task, poll for progress, then retrieve results. This allows long-running operations (1–10+ minutes) to work reliably with MCP clients. |
| 11 | + |
| 12 | +## Operation Tools |
| 13 | + |
| 14 | +### everyrow_screen |
| 15 | + |
| 16 | +Filter rows in a CSV based on criteria that require judgment. |
| 17 | + |
| 18 | +| Parameter | Type | Required | Description | |
| 19 | +|-----------|------|----------|-------------| |
| 20 | +| `task` | string | Yes | Screening criteria. Rows that meet the criteria pass. | |
| 21 | +| `input_csv` | string | Yes | Absolute path to input CSV. | |
| 22 | +| `response_schema` | object | No | JSON schema for custom fields. Default: `{passes: bool}`. | |
| 23 | + |
| 24 | +Returns `task_id` and `session_url`. Call `everyrow_progress` to monitor. |
| 25 | + |
| 26 | +### everyrow_rank |
| 27 | + |
| 28 | +Score and sort rows by qualitative criteria. |
| 29 | + |
| 30 | +| Parameter | Type | Required | Description | |
| 31 | +|-----------|------|----------|-------------| |
| 32 | +| `task` | string | Yes | What makes a row score higher or lower. | |
| 33 | +| `input_csv` | string | Yes | Absolute path to input CSV. | |
| 34 | +| `field_name` | string | Yes | Column name for the score. | |
| 35 | +| `field_type` | string | No | Score type: `float` (default), `int`, `str`, `bool`. | |
| 36 | +| `ascending_order` | bool | No | `true` = lowest first (default). | |
| 37 | +| `response_schema` | object | No | JSON schema for additional fields. | |
| 38 | + |
| 39 | +Returns `task_id` and `session_url`. Call `everyrow_progress` to monitor. |
| 40 | + |
| 41 | +### everyrow_dedupe |
| 42 | + |
| 43 | +Remove semantic duplicates. |
| 44 | + |
| 45 | +| Parameter | Type | Required | Description | |
| 46 | +|-----------|------|----------|-------------| |
| 47 | +| `equivalence_relation` | string | Yes | What makes two rows duplicates. | |
| 48 | +| `input_csv` | string | Yes | Absolute path to input CSV. | |
| 49 | + |
| 50 | +Returns `task_id` and `session_url`. Call `everyrow_progress` to monitor. |
| 51 | + |
| 52 | +### everyrow_merge |
| 53 | + |
| 54 | +Join two CSVs using intelligent entity matching. |
| 55 | + |
| 56 | +| Parameter | Type | Required | Description | |
| 57 | +|-----------|------|----------|-------------| |
| 58 | +| `task` | string | Yes | How to match rows between tables. | |
| 59 | +| `left_csv` | string | Yes | Absolute path to primary CSV. | |
| 60 | +| `right_csv` | string | Yes | Absolute path to secondary CSV. | |
| 61 | +| `merge_on_left` | string | No | Column in left table to match on. | |
| 62 | +| `merge_on_right` | string | No | Column in right table to match on. | |
| 63 | +| `use_web_search` | string | No | `auto` (default), `yes`, or `no`. | |
| 64 | + |
| 65 | +Returns `task_id` and `session_url`. Call `everyrow_progress` to monitor. |
| 66 | + |
| 67 | +### everyrow_agent |
| 68 | + |
| 69 | +Run web research agents on each row. |
| 70 | + |
| 71 | +| Parameter | Type | Required | Description | |
| 72 | +|-----------|------|----------|-------------| |
| 73 | +| `task` | string | Yes | Task for the agent to perform on each row. | |
| 74 | +| `input_csv` | string | Yes | Absolute path to input CSV. | |
| 75 | +| `response_schema` | object | No | JSON schema for structured output. Default: `{answer: str}`. | |
| 76 | + |
| 77 | +Returns `task_id` and `session_url`. Call `everyrow_progress` to monitor. |
| 78 | + |
| 79 | +## Progress and Results Tools |
| 80 | + |
| 81 | +### everyrow_progress |
| 82 | + |
| 83 | +Check progress of a running task. **Blocks for a few seconds** before returning. |
| 84 | + |
| 85 | +| Parameter | Type | Required | Description | |
| 86 | +|-----------|------|----------|-------------| |
| 87 | +| `task_id` | string | Yes | The task ID from an operation tool. | |
| 88 | + |
| 89 | +Returns status text with completion counts and elapsed time. Instructs the agent to call again immediately until the task completes or fails. |
| 90 | + |
| 91 | +### everyrow_results |
| 92 | + |
| 93 | +Retrieve results from a completed task and save to CSV. |
| 94 | + |
| 95 | +| Parameter | Type | Required | Description | |
| 96 | +|-----------|------|----------|-------------| |
| 97 | +| `task_id` | string | Yes | The task ID of the completed task. | |
| 98 | +| `output_path` | string | Yes | Directory or full .csv path for output. | |
| 99 | + |
| 100 | +Returns confirmation with row count and file path. |
| 101 | + |
| 102 | +## Workflow |
| 103 | + |
| 104 | +``` |
| 105 | +1. everyrow_agent(task, input_csv) |
| 106 | + → Returns task_id + session_url (~0.6s) |
| 107 | +
|
| 108 | +2. everyrow_progress(task_id) |
| 109 | + → Blocks 12s, returns "Running: 5/50 complete, 8 running (15s elapsed)" |
| 110 | + → Response says "call everyrow_progress again immediately" |
| 111 | +
|
| 112 | +3. everyrow_progress(task_id) (repeat) |
| 113 | + → "Running: 23/50 complete, 5 running (45s elapsed)" |
| 114 | +
|
| 115 | +4. everyrow_progress(task_id) (final) |
| 116 | + → "Completed: 49 succeeded, 1 failed (142s total)" |
| 117 | +
|
| 118 | +5. everyrow_results(task_id, output_path) |
| 119 | + → "Saved 50 rows to /path/to/agent_companies.csv" |
| 120 | +``` |
| 121 | + |
| 122 | +The agent handles this loop automatically. You don't need to intervene. |
| 123 | + |
| 124 | +## Custom Response Schemas |
| 125 | + |
| 126 | +All tools that accept `response_schema` take a JSON schema object: |
| 127 | + |
| 128 | +```json |
| 129 | +{ |
| 130 | + "properties": { |
| 131 | + "annual_revenue": { |
| 132 | + "type": "integer", |
| 133 | + "description": "Annual revenue in USD" |
| 134 | + }, |
| 135 | + "employee_count": { |
| 136 | + "type": "integer", |
| 137 | + "description": "Number of employees" |
| 138 | + } |
| 139 | + }, |
| 140 | + "required": ["annual_revenue"] |
| 141 | +} |
| 142 | +``` |
| 143 | + |
| 144 | +Supported types: `string`, `integer`, `number`, `boolean`, `array`, `object`. |
| 145 | + |
| 146 | +## Plugin |
| 147 | + |
| 148 | +The Claude Code plugin (`.claude-plugin/plugin.json`) bundles: |
| 149 | + |
| 150 | +1. MCP server, with all tools above |
| 151 | +2. Hooks, such as stop guard (prevents ending turn during operations), results notification (macOS), session cleanup |
| 152 | +3. Skill, to guide agents with quick SDK code generation for the Python SDK path |
| 153 | + |
| 154 | +Install with: |
| 155 | +```bash |
| 156 | +claude plugin marketplace add futuresearch/everyrow-sdk |
| 157 | +claude plugin install everyrow@futuresearch |
| 158 | +``` |
| 159 | + |
| 160 | +See [Progress Monitoring](/docs/progress-monitoring) for status line setup and hook details. |
0 commit comments