# Metaphor

```json
{
  "name": "Metaphor",
  "slug": "metaphor",
  "url": "https://composio.dev/toolkits/metaphor",
  "markdown_url": "https://composio.dev/toolkits/metaphor.md",
  "logo_url": "https://logos.composio.dev/api/metaphor",
  "categories": [
    "ai & machine learning"
  ],
  "is_composio_managed": false,
  "updated_at": "2026-05-12T10:18:50.886Z"
}
```

![Metaphor logo](https://logos.composio.dev/api/metaphor)

## Description

Securely connect your AI agents and chatbots (Claude, ChatGPT, Cursor, etc) with Metaphor MCP or direct API to perform neural web searches, discover contextually relevant content, summarize articles, and surface up-to-date online information through natural language.

## Summary

Metaphor is a neural search engine that understands how people describe and share content online. It empowers developers to deliver smarter, context-driven search experiences.

## Categories

- ai & machine learning

## Toolkit Details

- Tools: 1

## Images

- Logo: https://logos.composio.dev/api/metaphor

## Authentication

- **Api Key**
  - Type: `api_key`
  - Description: Api Key authentication for Metaphor.
  - Setup:
    - Configure Api Key credentials for Metaphor.
    - Use the credentials when creating an auth config in Composio.

## Suggested Prompts

- Fetch content of recent AI research links
- Get metadata for top-shared tech articles
- Retrieve full text from specific document IDs
- Summarize main points from latest blog posts

## Supported Tools

| Tool slug | Name | Description |
|---|---|---|
| `METAPHOR_GET_CONTENTS` | Get document contents by IDs | Tool to retrieve parsed HTML/text contents and metadata for documents by their IDs." Use when you need to fetch the full text and metadata of multiple documents at once. |

## Supported Triggers

None listed.

## Installation and MCP Setup

### Path 1: SDK Installation

#### Path 1, Step 1: Install Composio

Install the Composio SDK
```python
pip install composio_openai
```

```typescript
npm install @composio/openai
```

#### Path 1, Step 2: Initialize Composio and Create Tool Router Session

Import and initialize Composio client, then create a Tool Router session
```python
from openai import OpenAI
from composio import Composio
from composio_openai import OpenAIResponsesProvider

composio = Composio(provider=OpenAIResponsesProvider())
openai = OpenAI()
session = composio.create(user_id='your-user-id')
```

```typescript
import OpenAI from 'openai';
import { Composio } from '@composio/core';
import { OpenAIResponsesProvider } from '@composio/openai';

const composio = new Composio({
  provider: new OpenAIResponsesProvider(),
});
const openai = new OpenAI({});
const session = await composio.create('your-user-id');
```

#### Path 1, Step 3: Execute Metaphor Tools via Tool Router with Your Agent

Get tools from Tool Router session and execute Metaphor actions with your Agent
```python
tools = session.tools
response = openai.responses.create(
  model='gpt-4.1',
  tools=tools,
  input=[{
    'role': 'user',
    'content': 'Find recent blog posts on generative AI trends.'
  }]
)
result = composio.provider.handle_tool_calls(
  response=response,
  user_id='your-user-id'
)
print(result)
```

```typescript
const tools = session.tools;
const response = await openai.responses.create({
  model: 'gpt-4.1',
  tools: tools,
  input: [{
    role: 'user',
    content: 'Find recent blog posts on generative AI trends.'
  }],
});
const result = await composio.provider.handleToolCalls(
  'your-user-id',
  response.output
);
console.log(result);
```

### Path 2: MCP Server Setup

#### Path 2, Step 1: Install Composio

Install the Composio SDK and Claude Agent SDK
```python
pip install composio claude-agent-sdk
```

```typescript
npm install @composio/core ai @ai-sdk/openai @ai-sdk/mcp
```

#### Path 2, Step 2: Create Tool Router Session

Initialize the Composio client and create a Tool Router session
```python
from composio import Composio
from claude_agent_sdk import ClaudeSDKClient, ClaudeAgentOptions

composio = Composio(api_key='your-composio-api-key')
session = composio.create(user_id='your-user-id')
url = session.mcp.url
```

```typescript
import { Composio } from '@composio/core';

const composio = new Composio({ apiKey: 'your-api-key' });

console.log("Creating Tool Router session...");
const { mcp } = await composio.create('your-user-id');
console.log(`Tool Router session created: ${mcp.url}`);
```

#### Path 2, Step 3: Connect to AI Agent

Use the MCP server with your AI agent
```python
import asyncio

options = ClaudeAgentOptions(
    permission_mode='bypassPermissions',
    mcp_servers={
        'tool_router': {
            'type': 'http',
            'url': url,
            'headers': {
                'x-api-key': 'your-composio-api-key'
            }
        }
    },
    system_prompt='You are a helpful assistant with access to Metaphor tools.',
    max_turns=10
)

async def main():
    async with ClaudeSDKClient(options=options) as client:
        await client.query('Get document contents for these Metaphor IDs: 12345, 67890')
        async for message in client.receive_response():
            if hasattr(message, 'content'):
                for block in message.content:
                    if hasattr(block, 'text'):
                        print(block.text)

asyncio.run(main())
```

```typescript
import { openai } from '@ai-sdk/openai';
import { experimental_createMCPClient as createMCPClient } from '@ai-sdk/mcp';
import { generateText, stepCountIs } from 'ai';

const client = await createMCPClient({
  transport: {
    type: 'http',
    url: mcp.url,
    headers: { 'x-api-key': 'your-composio-api-key' }
  }
});

const tools = await client.tools();

const { text } = await generateText({
  model: openai('gpt-4o'),
  tools,
  messages: [{ role: 'user', content: 'Get document contents for these Metaphor IDs: 12345, 67890' }],
  stopWhen: stepCountIs( 5 )
});

console.log(`Agent: ${text}`);
```

## Why Use Composio?

### 1. AI Native Metaphor Integration

- Supports both Metaphor MCP and direct API based integrations
- Structured, LLM-friendly schemas for reliable tool execution
- Rich coverage for searching, filtering, and retrieving the latest web data

### 2. Managed Auth

- Built-in API key management for Metaphor
- Central place to manage, scope, and revoke Metaphor access
- Per user and per environment credentials—no hard-coded keys required

### 3. Agent Optimized Design

- Tools are tuned using real error and success rates to improve reliability over time
- Comprehensive execution logs so you always know what ran, when, and on whose behalf

### 4. Enterprise Grade Security

- Fine-grained RBAC so you control which agents and users can access Metaphor
- Scoped, least privilege access to Metaphor resources
- Full audit trail of agent actions to support review and compliance

## Use Metaphor with any AI Agent Framework

Choose a framework you want to connect Metaphor with:

- [OpenAI Agents SDK](https://composio.dev/toolkits/metaphor/framework/open-ai-agents-sdk)
- [Claude Agent SDK](https://composio.dev/toolkits/metaphor/framework/claude-agents-sdk)
- [Claude Code](https://composio.dev/toolkits/metaphor/framework/claude-code)
- [Claude Cowork](https://composio.dev/toolkits/metaphor/framework/claude-cowork)
- [Codex](https://composio.dev/toolkits/metaphor/framework/codex)
- [OpenClaw](https://composio.dev/toolkits/metaphor/framework/openclaw)
- [Hermes](https://composio.dev/toolkits/metaphor/framework/hermes-agent)
- [Google ADK](https://composio.dev/toolkits/metaphor/framework/google-adk)
- [LangChain](https://composio.dev/toolkits/metaphor/framework/langchain)
- [Vercel AI SDK](https://composio.dev/toolkits/metaphor/framework/ai-sdk)
- [Mastra AI](https://composio.dev/toolkits/metaphor/framework/mastra-ai)
- [LlamaIndex](https://composio.dev/toolkits/metaphor/framework/llama-index)
- [CrewAI](https://composio.dev/toolkits/metaphor/framework/crew-ai)
- [Pydantic AI](https://composio.dev/toolkits/metaphor/framework/pydantic-ai)
- [AutoGen](https://composio.dev/toolkits/metaphor/framework/autogen)

## Related Toolkits

- [Composio](https://composio.dev/toolkits/composio) - Composio is an integration platform that connects AI agents with hundreds of business tools. It streamlines authentication and lets you trigger actions across services—no custom code needed.
- [Composio search](https://composio.dev/toolkits/composio_search) - Composio search is a unified web search toolkit spanning travel, e-commerce, news, financial markets, images, and more. It lets you and your apps tap into up-to-date web data from a single, easy-to-integrate service.
- [Perplexityai](https://composio.dev/toolkits/perplexityai) - Perplexityai delivers natural, conversational AI models for generating human-like text. Instantly get context-aware, high-quality responses for chat, search, or complex workflows.
- [Ai ml api](https://composio.dev/toolkits/ai_ml_api) - Ai ml api is a suite of AI/ML models for natural language and image tasks. It provides fast, scalable access to advanced AI capabilities for your apps and workflows.
- [Aivoov](https://composio.dev/toolkits/aivoov) - Aivoov is an AI-powered text-to-speech platform offering 1,000+ voices in over 150 languages. Instantly turn written content into natural, human-like audio for any application.
- [All images ai](https://composio.dev/toolkits/all_images_ai) - All-Images.ai is an AI-powered image generation and management platform. It helps you create, search, and organize images effortlessly with advanced AI capabilities.
- [Anthropic administrator](https://composio.dev/toolkits/anthropic_administrator) - Anthropic administrator is an API for managing Anthropic organizational resources like members, workspaces, and API keys. It helps you automate admin tasks and streamline resource management across your Anthropic organization.
- [Api labz](https://composio.dev/toolkits/api_labz) - Api labz is a platform offering a suite of AI-driven APIs and workflow tools. It helps developers automate tasks and build smarter, more efficient applications.
- [Apipie ai](https://composio.dev/toolkits/apipie_ai) - Apipie ai is an AI model aggregator offering a single API for accessing top AI models from multiple providers. It helps developers build cost-efficient, latency-optimized AI solutions without juggling multiple integrations.
- [Astica ai](https://composio.dev/toolkits/astica_ai) - Astica ai provides APIs for computer vision, NLP, and voice synthesis. Integrate advanced AI features into your app with a single API key.
- [Bigml](https://composio.dev/toolkits/bigml) - BigML is a machine learning platform that lets you build, train, and deploy predictive models from your data. Its intuitive interface and robust API make machine learning accessible and efficient.
- [Chatbotkit](https://composio.dev/toolkits/chatbotkit) - Chatbotkit is a platform for building and managing AI-powered chatbots using robust APIs and SDKs. It lets you easily add conversational AI to your apps for better user engagement.
- [Cody](https://composio.dev/toolkits/cody) - Cody is an AI assistant built for businesses, trained on your company's knowledge and data. It delivers instant answers and insights, tailored for your team.
- [Context7 MCP](https://composio.dev/toolkits/context7_mcp) - Context7 MCP delivers live, version-specific code docs and examples right from the source. It helps developers and AI agents instantly retrieve authoritative programming info—no more out-of-date docs.
- [Customgpt](https://composio.dev/toolkits/customgpt) - CustomGPT.ai lets you build and deploy chatbots tailored to your own data and business needs. Get precise and context-aware AI conversations without writing code.
- [Datarobot](https://composio.dev/toolkits/datarobot) - Datarobot is a machine learning platform that automates model development, deployment, and monitoring. It empowers organizations to quickly gain predictive insights from large datasets.
- [Deepgram](https://composio.dev/toolkits/deepgram) - Deepgram is an AI-powered speech recognition platform for accurate audio transcription and understanding. It enables fast, scalable speech-to-text with advanced audio intelligence features.
- [DeepImage](https://composio.dev/toolkits/deepimage) - DeepImage is an AI-powered image enhancer and upscaler. Get higher-quality images with just a few clicks.
- [DeepSeek](https://composio.dev/toolkits/deepseek) - DeepSeek offers AI-powered chat, search, and language model services. It delivers advanced conversational and information retrieval tools for smarter workflows.
- [E2b](https://composio.dev/toolkits/e2b) - E2b is an open-source platform for running code in secure, sandboxed environments. It enables safe multi-language code execution for AI-powered apps.

## Frequently Asked Questions

### Do I need my own developer credentials to use Metaphor with Composio?

Yes, Metaphor requires you to configure your own API key credentials. Once set up, Composio handles secure credential storage and API request handling for you.

### Can I use multiple toolkits together?

Yes! Composio's Tool Router enables agents to use multiple toolkits. [Learn more](https://docs.composio.dev/tool-router/overview).

### Is Composio secure?

Composio is SOC 2 and ISO 27001 compliant with all data encrypted in transit and at rest. [Learn more](https://trust.composio.dev).

### What if the API changes?

Composio maintains and updates all toolkit integrations automatically, so your agents always work with the latest API versions.

---
[See all toolkits](https://composio.dev/toolkits) · [Composio docs](https://docs.composio.dev/llms.txt)