Skip to main content

Documentation Index

Fetch the complete documentation index at: https://hypha-docs.plinqx.app/llms.txt

Use this file to discover all available pages before exploring further.

Collections are the primary way you organize and expose tools to AI clients. Think of them as curated toolboxes that control which tools are available to specific API keys.

​
Why Collections Matter

Collections provide:
  • Access Control: API keys are scoped to Collections, limiting which tools AI clients can access
  • Tool Curation: Choose exactly which tools from your providers, custom tools, and MCP servers are exposed
  • Policy Scope: Apply governance policies at the Collection level
  • Organization: Group related tools logically (e.g., “Salesforce Tools”, “Internal APIs”)

​
Creating a Collection

1

Navigate to Collections

Click Collections in the sidebar.
2

Create Collection

Click Create Collection and provide:
  • Name: A descriptive name (e.g., “Salesforce Production”)
  • Description: Optional description of the collection’s purpose

​
Adding Tools to Collections

Once you’ve created a collection, add tools from any source:
1

Open Collection

Click on a collection to view its details.
2

Add Tools

Click Add Tools to open the tool selector.
3

Select Tools

Choose tools from:
  • Providers: Salesforce tools
  • Custom Tools: Your custom-built tools
  • Imported Tools: Tools imported from OpenAPI specs
  • MCP Servers: Tools from connected MCP servers
  • Flows: Published flows exposed as MCP tools

​
Configuring Tools in Collections

Each tool in a collection can be individually configured:

​
Tool Settings

Click the Settings icon next to any tool to configure:
  • Alias: Rename the tool for AI clients (e.g., sf_query instead of SALESFORCE_PROD_sf_query)
  • Enabled: Toggle tool availability on/off
  • Credential Policy: How credentials are resolved:
    • System: Use tenant-level credentials
    • User Required: Each user must connect their own credentials
    • User Preferred: Use user credentials if available, fall back to system

​
Rate Limiting

Configure per-tool rate limits:
  • Window: Time window (per minute, per hour, per day)
  • Limit: Maximum calls per window
  • Scope: Apply to all principals or specific ones

​
Field Masking

Mask sensitive fields in tool responses:
  • Input Masking: Hide fields in request logs
  • Output Masking: Redact fields from responses
Field masking is useful for protecting sensitive data like API keys, tokens, or personal information.

​
Usage Quotas

Set daily or monthly quotas for tool usage:
  • Daily Quota: Maximum calls per day
  • Monthly Quota: Maximum calls per month
Quotas are enforced at the tool level. Once exceeded, the tool will be unavailable until the quota resets.

​
Managing Collections

​
Editing Collections

Click Edit on a collection to:
  • Update name and description
  • Configure cache settings
  • View usage statistics

​
Deleting Collections

Deleting a collection removes all tool configurations within it. This action cannot be undone.
To delete a collection:
  1. Open the collection
  2. Click Delete Collection
  3. Confirm the deletion

​
Linking API Keys

Collections must be linked to API keys for AI clients to access them:
1

Open Collection

Navigate to the collection details page.
2

Link API Keys

Click Link API Keys and select which API keys should have access to this collection.
An API key can be linked to multiple collections, giving it access to all tools in those collections.

​
Collection Cache Settings

Collections support response caching to improve performance:
  • Cache Enabled: Toggle caching on/off
  • TTL: Time-to-live for cached responses (in seconds)
  • Tool-Specific Rules: Override collection cache settings per tool

​
Best Practices

Organize by Purpose

Create collections that group tools by use case (e.g., “Customer Support Tools”, “Data Analytics”)

Limit Scope

Only add tools that are needed for each collection’s purpose

Use Aliases

Create friendly aliases for complex tool names

Test First

Use the Playground to test tools before adding them to production collections

​
Next Steps

Create API Keys

Generate API keys for your collections

Set Up Policies

Configure governance policies for collections