You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
> Video tutorial: [Watch here](https://www.youtube.com/watch?v=MkU23U2VE9E)
102
101
103
-
1.[Fork](https://github.com/ccbikai/Sink/fork) the repository to your GitHub account.
104
-
2. Create a project in [Cloudflare Pages](https://developers.cloudflare.com/pages/).
105
-
3. Select the `Sink` repository and choose the `Nuxt.js` preset.
106
-
4. Configure the following environment variables:
107
-
-`NUXT_SITE_TOKEN`: Must be longer than **8** characters. This token grants access to your dashboard.
108
-
-`NUXT_CF_ACCOUNT_ID`: Locate your [account ID](https://developers.cloudflare.com/fundamentals/setup/find-account-and-zone-ids/).
109
-
-`NUXT_CF_API_TOKEN`: Create a [Cloudflare API token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/) with at least `Account.Account Analytics` permissions. [See reference.](https://developers.cloudflare.com/analytics/analytics-engine/sql-api/#authentication)
110
-
111
-
5. Save and deploy the project.
112
-
6. Cancel the deployment, then navigate to **Settings** -> **Bindings** -> **Add**:
113
-
-**KV Namespace**: Bind the variable name `KV` to a [KV namespace](https://developers.cloudflare.com/kv/) (create a new one under **Storage & Databases** -> **KV**).
114
-
-**Workers AI** (_Optional_): Bind the variable name `AI` to the Workers AI Catalog.
115
-
-**Analytics Engine**:
116
-
- In **Workers & Pages**, go to **Account details** on the right side, find `Analytics Engine`, and click `Set up` to enable the free version.
117
-
- Return to **Settings** -> **Bindings** -> **Add** and select **Analytics engine**.
118
-
- Bind the variable name `ANALYTICS` to the `sink` dataset.
119
-
120
-
7. Redeploy the project.
121
-
8. Update code, refer to the official GitHub documentation [Syncing a fork branch from the web UI](https://docs.github.com/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork#syncing-a-fork-branch-from-the-web-ui).
102
+
We currently support deployment to [Cloudflare Workers](./docs/deployment/workers.md) (recommended) and [Cloudflare Pages](./docs/deployment/pages.md).
122
103
123
104
## ⚒️ Configuration
124
105
@@ -128,6 +109,32 @@ We welcome your contributions and PRs.
128
109
129
110
[API Docs](./docs/api.md)
130
111
112
+
## 🧰 MCP
113
+
114
+
We currently do not support native MCP Server, but we have OpenAPI documentation, and you can use the following method to support MCP.
115
+
116
+
> Replace the domain name in `OPENAPI_SPEC_URL` with your own domain name.
117
+
>
118
+
> The `API_KEY` is the same as the `NUXT_SITE_TOKEN` in the environment variables.
1.[Fork](https://github.com/ccbikai/Sink/fork) the repository to your GitHub account.
4
+
2. Create a project in [Cloudflare Pages](https://developers.cloudflare.com/pages/).
5
+
3. Select the `Sink` repository and choose the `Nuxt.js` preset.
6
+
4. Configure the following environment variables:
7
+
-`NUXT_SITE_TOKEN`: Must be at least **8** characters long. This token grants access to your dashboard.
8
+
-`NUXT_CF_ACCOUNT_ID`: Find your [account ID](https://developers.cloudflare.com/fundamentals/setup/find-account-and-zone-ids/).
9
+
-`NUXT_CF_API_TOKEN`: Create a [Cloudflare API token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/) with at least `Account.Account Analytics` permission. [See reference.](https://developers.cloudflare.com/analytics/analytics-engine/sql-api/#authentication)
10
+
11
+
5. Save and deploy the project.
12
+
6. Cancel the deployment, then go to **Settings** -> **Bindings** -> **Add**:
13
+
-**KV Namespace**: Bind the variable name `KV` to a [KV namespace](https://developers.cloudflare.com/kv/) (create a new one under **Storage & Databases** -> **KV**).
14
+
-**Workers AI** (_Optional_): Bind the variable name `AI` to the Workers AI Catalog.
15
+
-**Analytics Engine**:
16
+
- In **Workers & Pages**, go to **Account details** in the right panel, locate `Analytics Engine`, and click `Set up` to enable the free tier.
17
+
- Return to **Settings** -> **Bindings** -> **Add** and select **Analytics engine**.
18
+
- Bind the variable name `ANALYTICS` to the `sink` dataset.
19
+
20
+
7. Add Compatibility flags
21
+
- Go to **Settings** -> **Runtime** -> **Compatibility flags** and set the following flags `nodejs_compat`.
22
+
8. Redeploy the project.
23
+
9. To update code, refer to the official GitHub documentation [Syncing a fork branch from the web UI](https://docs.github.com/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork#syncing-a-fork-branch-from-the-web-ui).
0 commit comments