Skip to content

Commit 0d118a7

Browse files
committed
feat: update description, remove log and add banner
1 parent 2d4c607 commit 0d118a7

File tree

7 files changed

+60
-24
lines changed

7 files changed

+60
-24
lines changed

README.md

Lines changed: 60 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,25 @@
11
<h1 align="center">
2-
<a href="https://apify.com">
2+
<style>
3+
@media (prefers-color-scheme: dark) {
4+
.mcp-url { color: #A78BFA !important; }
5+
.mcp-desc { color: #FFFFFF !important; }
6+
}
7+
@media (prefers-color-scheme: light) {
8+
.mcp-url { color: #8B5CF6 !important; }
9+
.mcp-desc { color: #000000 !important; }
10+
}
11+
</style>
12+
<a href="https://mcp.apify.com">
313
<picture>
4-
<!-- TODO: Replace with the latest Apify logo once they are released -->
5-
<source media="(prefers-color-scheme: dark)" srcset="docs/apify_logo_512px_old.png">
6-
<img alt="Apify MCP Server" src="docs/apify_logo_white_512px_old.png" width="500">
14+
<source media="(prefers-color-scheme: dark)" srcset="docs/apify_mcp_server_banner_dark.png">
15+
<img alt="Apify MCP Server" src="docs/apify_mcp_server_banner.png" width="500">
716
</picture>
817
</a>
918
<br>
10-
<small>Instantly connect AI apps and agents to thousands of ready‑built tools</small>
19+
<small>
20+
<span class="mcp-url">mcp.apify.com:</span>
21+
<span class="mcp-desc">instantly connect AI apps and agents to thousands of ready‑built tools</span>
22+
</small>
1123
</h1>
1224

1325
<p align=center>
@@ -21,20 +33,28 @@
2133

2234
The Apify Model Context Protocol (MCP) Server allows AI applications and agents to connect to Apify’s extensive [library of Actors](https://apify.com/store) as tools to perform web scraping, data extraction, and other automation tasks in real time.
2335

36+
> **🚀 Try the hosted Apify MCP Server!**
37+
>
38+
> For the easiest setup and most powerful features, including the ability to find and use any Actor from Apify Store, connect your AI assistant to our hosted server:
39+
>
40+
> **[`https://mcp.apify.com`](https://mcp.apify.com)**
41+
>
42+
> It supports OAuth, so you can connect from clients like Claude.ai or Visual Studio Code with just the URL.
43+
2444
![Actors-MCP-server](https://raw.githubusercontent.com/apify/actors-mcp-server/refs/heads/master/docs/actors-mcp-server.png)
2545

2646
## Table of Contents
27-
- [🌐 Introducing the Apify MCP Server](#-introducing-the-apify-mcp-server)
47+
- [🌐 Introducing the Apify MCP server](#-introducing-the-apify-mcp-server)
2848
- [🚀 Quickstart](#-quickstart)
29-
- [🤖 MCP Clients and Examples](#-mcp-clients-and-examples)
30-
- [🎮 Try Apify MCP Instantly](#-try-apify-mcp-instantly)
31-
- [🧱 Tools, Resources, and Prompts](#-tools-resources-and-prompts)
32-
- [🐛 Troubleshooting](#-troubleshooting)
33-
- [👷🏼 Development](#-development)
34-
- [👨‍💻 Contributing](#-contributing)
49+
- [🤖 MCP clients and examples](#-mcp-clients-and-examples)
50+
- [🪄 Try Apify MCP instantly](#-try-apify-mcp-instantly)
51+
- [🛠️ Tools, resources, and prompts](#-tools-resources-and-prompts)
52+
- [🐛 Troubleshooting (local MCP server)](#-troubleshooting-local-mcp-server)
53+
- [⚙️ Development](#-development)
54+
- [🤝 Contributing](#-contributing)
3555
- [📚 Learn more](#-learn-more)
3656

37-
# 🌐 Introducing the Apify MCP Server
57+
# 🌐 Introducing the Apify MCP server
3858

3959
The Apify MCP Server allows an AI assistant to use any [Apify Actor](https://apify.com/store) as a tool to perform a specific task.
4060
For example, it can:
@@ -52,7 +72,7 @@ https://www.youtube.com/watch?v=BKu8H91uCTg
5272

5373
You can use the Apify MCP Server in two ways:
5474

55-
**HTTPS Endpoint (mcp.apify.com)**: Connect from your MCP client via OAuth or by including the `Authorization: Bearer <APIFY_TOKEN>` header in your requests.
75+
**HTTPS Endpoint (mcp.apify.com)**: Connect from your MCP client via OAuth or by including the `Authorization: Bearer <APIFY_TOKEN>` header in your requests. This is the recommended method for most use cases. Because it supports OAuth, you can connect from clients like [Claude.ai](https://claude.ai) or [Visual Studio Code](https://code.visualstudio.com/) using just the URL: `https://mcp.apify.com`.
5676
- `https://mcp.apify.com` (recommended) for streamable transport
5777
- `https://mcp.apify.com/sse` for legacy SSE transport
5878

@@ -62,7 +82,7 @@ You can use the Apify MCP Server in two ways:
6282

6383
You can find detailed instructions for setting up the MCP server in the [Apify documentation](https://docs.apify.com/platform/integrations/mcp).
6484

65-
# 🤖 MCP Clients and examples
85+
# 🤖 MCP clients and examples
6686

6787
To interact with the Apify MCP server, you can use various MCP clients, such as:
6888
- [Claude Desktop](https://claude.ai/download)
@@ -79,7 +99,21 @@ With MCP server integrated, you can ask your AI assistant things like:
7999
- "Provide a step-by-step guide on using the Model Context Protocol, including source URLs."
80100
- "What Apify Actors can I use?"
81101

82-
# 🎮 Try Apify MCP Instantly
102+
### Supported Clients Matrix
103+
104+
The following table outlines the tested MCP clients and their level of support for key features.
105+
106+
| Client | Dynamic Tool Discovery | Notes |
107+
| --- | --- | --- |
108+
| **Claude.ai (web)** | ✅ Full | |
109+
| **Claude Desktop** | 🟡 Partial | Tools may need to be reloaded manually in the client. |
110+
| **VS Code (Genie)** | ✅ Full | |
111+
| **LibreChat** | ❓ Untested | |
112+
| **Apify Tester MCP Client** | ✅ Full | Designed for testing Apify MCP servers. |
113+
114+
*This matrix is a work in progress. If you have tested other clients, please consider contributing to this documentation.*
115+
116+
# 🪄 Try Apify MCP Instantly
83117

84118
Want to try Apify MCP without any setup?
85119

@@ -88,7 +122,7 @@ Check out [Apify Tester MCP Client](https://apify.com/jiri.spilka/tester-mcp-cli
88122
This interactive, chat-like interface provides an easy way to explore the capabilities of Apify MCP without any local setup.
89123
Just sign in with your Apify account and start experimenting with web scraping, data extraction, and automation tools!
90124

91-
# 🧱 Tools, Resources, and Prompts
125+
# 🛠️ Tools, resources, and prompts
92126

93127
The MCP server provides a set of tools for interacting with Apify Actors.
94128
Since the Apify Store is large and growing rapidly, the MCP server provides a way to dynamically discover and use new Actors.
@@ -100,6 +134,7 @@ By default, the server is pre-configured with one Actor, `apify/rag-web-browser`
100134
The MCP server loads an Actor's input schema and creates a corresponding MCP tool.
101135
This allows the AI agent to know exactly what arguments to pass to the Actor and what to expect in return.
102136

137+
103138
For example, for the `apify/rag-web-browser` Actor, the input parameters are:
104139

105140
```json
@@ -118,10 +153,10 @@ One of the most powerful features of using MCP with Apify is dynamic tool discov
118153
It gives an AI agent the ability to find new tools (Actors) as needed and incorporate them.
119154
Here are some special MCP operations and how the Apify MCP Server supports them:
120155

121-
- Actor discovery and management: Search for Actors (`search-actors`), view details (`get-actor-details`), and dynamically add them (`add-actor`).
122-
- Apify documentation: Search Apify documentation (`search-apify-docs`) and fetch specific documents (`fetch-apify-docs`).
123-
- Actor runs (*): Get a list of your Actor runs (`get-actor-run-list`), specific run details (`get-actor-run`), and logs from a specific Actor run (`get-actor-log`).
124-
- Apify storage (*): Access datasets (`get-dataset`, `get-dataset-items`, `get-dataset-list`), key-value stores (`get-key-value-store`, `get-key-value-store-keys`, `get-key-value-store-record`, `get-key-value-store-records`), and their records.
156+
- **Actor discovery and management**: Search for Actors, view their details, and dynamically add or remove them as available tools for the AI.
157+
- **Apify documentation**: Search the Apify documentation and fetch specific documents to provide context to the AI.
158+
- **Actor runs (*)**: Get lists of your Actor runs, inspect their details, and retrieve logs.
159+
- **Apify storage (*)**: Access data from your datasets and key-value stores.
125160

126161
**Note**: Helper tool categories marked with (*) are not enabled by default in the MCP server and must be explicitly enabled using the `tools` argument (either the `--tools` command line argument for the stdio server or the `?tools` URL query parameter for the remote MCP server). The `tools` argument is a comma-separated list of categories with the following possible values:
127162

@@ -145,7 +180,7 @@ export APIFY_TOKEN="your-apify-token"
145180
npx @modelcontextprotocol/inspector npx -y @apify/actors-mcp-server
146181
```
147182

148-
# 👷🏼 Development
183+
# ⚙️ Development
149184

150185
## Prerequisites
151186

@@ -182,7 +217,7 @@ Upon launching, the Inspector will display a URL that you can open in your brows
182217
- Make sure the `APIFY_TOKEN` environment variable is set.
183218
- Always use the latest version of the MCP server by using `@apify/actors-mcp-server@latest`.
184219

185-
## Limitations
220+
## 💡 Limitations
186221

187222
The Actor input schema is processed to be compatible with most MCP clients while adhering to [JSON Schema](https://json-schema.org/) standards. The processing includes:
188223
- **Descriptions** are truncated to 500 characters (as defined in `MAX_DESCRIPTION_LENGTH`).
@@ -191,8 +226,9 @@ The Actor input schema is processed to be compatible with most MCP clients while
191226
- **Nested properties** are built for special cases like proxy configuration and request list sources to ensure the correct input structure.
192227
- **Array item types** are inferred when not explicitly defined in the schema, using a priority order: explicit type in items > prefill type > default value type > editor type.
193228
- **Enum values and examples** are added to property descriptions to ensure visibility, even if the client doesn't fully support the JSON schema.
229+
- **Rental Actors** are only available for use with the hosted MCP server at https://mcp.apify.com. When running the server locally via stdio, you can only access Actors that are already added to your local toolset. To dynamically search for and use any Actor from the Apify Store—including rental Actors—connect to the hosted endpoint.
194230

195-
# 👨‍💻 Contributing
231+
# 🤝 Contributing
196232

197233
We welcome contributions to improve the Apify MCP Server! Here's how you can help:
198234

docs/apify_logo_512px_old.png

-30 KB
Binary file not shown.

docs/apify_logo_black.png

-9.44 KB
Binary file not shown.

docs/apify_logo_white.png

-11.1 KB
Binary file not shown.
-28.2 KB
Binary file not shown.

docs/apify_mcp_server_banner.png

59.1 KB
Loading
41.5 KB
Loading

0 commit comments

Comments
 (0)