Developer
Developer
Connect an agent to Sift, or build an integration with the REST API. Start with the agent guide, then use the field references for exact requests.
At a glance
| Goal | Start here |
|---|---|
| Give an agent a simple working procedure | Agent guide |
| Connect an MCP client | MCP connections |
| Find records, count, compare, or chart | MCP execute |
| Chain operations or make supported changes | MCP execute |
| Build an HTTP integration | REST API |
| Read exact inputs | sift.spec(id) (TypeScript) or OpenAPI (JSON Schema) |
Read these docs as an agent
| Resource | Use it for |
|---|---|
| llms.txt | A short index. Start here and fetch only the relevant page. |
| llms-full.txt | Public docs in one text response, with developer guides first. |
| Agent guide as Markdown | Copyable agent instructions and recipes. |
| MCP fields as Markdown | Direct tool inputs and data contracts. |
| API fields as Markdown | Every declared REST field. |
| OpenAPI JSON | Exact REST request and response schemas. |
Use the index plus focused pages for most tasks. Use the full text when the client needs one document.
For MCP operations, read the current declaration with sift.spec(id) instead of assuming a static reference never changes.
What's in here
Agent guide
A short working procedure, copyable instructions, and practical recipes.
MCP connections
Connect a client, choose authentication, and understand access controls.
MCP overview
Choose a tool and understand reads, writes, and human confirmation.
MCP field reference
Tool inputs, search sources, analytics fields, and result contracts.
Record field dictionary
What pmid, prid, identifiers, scores, and returned row fields mean.
REST API
Authentication, endpoints, request examples, and error handling.
API field reference
Filters, pagination, action fields, custom fields, and ingestion.
API keys
Create, use, rotate, and revoke organization keys.
Query syntax
The filter language for Search and supported API fields.
Metrics reference
Definitions and calculations for analytics metrics.
Who uses this
Agent builders use MCP for discovery and permission-checked operations. Integration developers use the REST API for explicit HTTP requests.
Both connections stay within their authenticated organization. MCP tool availability also depends on the person's access and enabled features.