How to Connect Aymakan to Microsoft Copilot via MCP

💡 No install? Use cloud.anythingmcp.com directly. Sign in, click Connectors → Aymakan, paste your credentials, mint an MCP API key and you're done. No Docker, no git clone, no local server.

Aymakan + Microsoft Copilot

Aymakan courier (Saudi Arabia) from an AI agent: track shipments by tracking number or order reference, list your shipments, AWB label links, pickup requests and time slots, cities, PUDO points, warehouses and saved addresses. Creating and cancelling shipments and pickups is included, installed switched off.

Prerequisites

See the full setup instructions baked into the connector (visible in the in-app store when you select the connector). The required environment variables for this connector are:

AYMAKAN_API_KEY

Step 1 — Get credentials

Setting up takes about 2 minutes. You need a customer account with Aymakan, the Saudi courier.

1. Sign in to the Aymakan customer dashboard.
2. Open Technical → AyMakan API and copy the API key (the security code).
3. Paste it into AYMAKAN_API_KEY exactly as it is, without the word Bearer.
4. Install the connector and run aymakan_ping: logged_in must say Yes.

Use the production key: a key from Aymakan's development environment answers Invalid Credentials here. Regenerating the key in the dashboard makes the old one stop working, so update every other integration that still uses it.

What it reads: your shipments by tracking number or by your own order reference, with delivery and collection details, cash on delivery amount, weight, pieces, current status and the full status history in English and Arabic; the list of all shipments of your account with delivery attempts and main dates; label (AWB) links; your pickup requests, the cities where pickups are possible and the free time slots for a date; the cities Aymakan delivers to; PUDO points such as lockers and partner shops; Aymakan's warehouses; and the collection addresses saved on your account.

Labels only before pickup: Aymakan returns the PDF label link only while a shipment is still in status AY-0001 (created, not yet picked up). After pickup the API answers 422, so print your labels before the courier comes. For several shipments the AI can fetch one PDF with all their labels.

Tracking by your order number: works only for shipments that were created with a reference, and only shipments of your own account are found. A reference that does not exist answers No Shipments Found.

Switched off at install: aymakan_create_shipment, aymakan_cancel_shipment, aymakan_create_pickup_request and aymakan_cancel_pickup_request. They book or cancel real courier work, so an administrator turns them on deliberately. Even then the AI first shows you the shipment (receiver, city, cash on delivery amount, pieces), the tracking number or the pickup request, and waits for your yes. A shipment can be cancelled only while in AY-0001, a pickup request only while pending or processing.

Limits: the shipment list comes in fixed pages of 100 (about 110 KB each), so for a single shipment the AI uses tracking instead. Aymakan limits the number of pickup requests per customer and day.

Common errors: 401 Invalid Credentials means a wrong key, an old key after regeneration, or a development key. 422 carries the reason in the message, for example No Shipments Found, a validation error per field, or a label request for a shipment that is already past AY-0001.

The connector does not handle cash on delivery settlements or invoices, and it does not book or cancel shipments or pickups unless an administrator has turned those tools on.

Step 2 — Install the adapter

curl -fsSL https://raw.githubusercontent.com/HelpCode-ai/anythingmcp/main/docker-compose.quickstart.yml -o docker-compose.yml
printf 'JWT_SECRET=%s\nENCRYPTION_KEY=%s\n' "$(openssl rand -hex 32)" "$(openssl rand -hex 32)" > .env
docker compose up -d

Step 3 — Add the connector in Microsoft Copilot

Your server URL: in AnythingMCP, open MCP Servers → the server this connector is on, and copy its URL (https://cloud.anythingmcp.com/mcp/…). Use it wherever this guide shows YOUR_SERVER_ID.

Microsoft Copilot uses MCP servers through agents built in Copilot Studio: you add AnythingMCP to an agent as a tool, then publish the agent to Microsoft 365 Copilot and Teams. Copilot Studio connects from Microsoft's cloud over Streamable HTTP, which AnythingMCP supports.

1. In Copilot Studio, open your agent (or create one), go to Tools and choose Add a tool → New tool → Model Context Protocol.
2. Enter a Server name (for example AnythingMCP), a Server description that says what the connector does, and the Server URL https://cloud.anythingmcp.com/mcp/YOUR_SERVER_ID. Copilot Studio uses the description to decide when to call the server.
3. Under authentication, choose API key, set Type to Header and the header name to X-API-Key, then select Create.
4. In Add tool, choose Create a new connection, paste an MCP API key from AnythingMCP (MCP Servers → your server → API keys) and select Add to agent.
5. Try it in the agent's Test pane: ask for something that needs the Aymakan tools.
6. Select Publish, then Channels → Microsoft 365 and Microsoft Teams, keep Make agent available in Microsoft Copilot selected and choose Add channel. See agent in Teams installs it for you; in Microsoft 365 Copilot, type @ and pick the agent.

Prefer per-user sign-in? Choose OAuth 2.0 → Dynamic discovery instead of an API key: each user then signs in to AnythingMCP the first time the agent calls it.

Self-hosting? Use your instance's public HTTPS address instead of https://cloud.anythingmcp.com. Copilot Studio connects from Microsoft's cloud, so localhost does not work.

Available tools

Example prompts

• "Where are shipments AY2866494373 and AY2866494374 right now?"
• "Find the shipment for our order reference 10045 and show me its full status history."
• "Which of my shipments this week needed more than one delivery attempt, and in which cities?"
• "Give me one PDF with the labels of every shipment created today that has not been picked up yet."
• "Which pickup time slots are free tomorrow, and which of my pickup requests are still pending?"

FAQ

Which Copilot is this for? Microsoft 365 Copilot at work, through agents built in Copilot Studio. The Microsoft Copilot app for personal accounts has no option to add your own MCP server.

What do I need? A work account with access to Copilot Studio (a license or a trial) to build the agent. People who use it in Microsoft 365 Copilot or Teams need access to the agent: share it with them, or ask an admin to publish it to the organization. If your organization applies data policies to Power Platform connectors, they cover MCP servers too.

The agent doesn't call the tools. Check that the header name is exactly X-API-Key and that the key belongs to the same MCP server as the URL, and make the server description specific: Copilot Studio uses it to decide when to call the server. Publish the agent again after each change; in an open chat, type "start over" to get the new version.

Next steps

• Connector landing page
• Connect to Claude
• Connect to ChatGPT
• Connect to Cursor
• Connect to Gemini
• Connect to Meta Muse