{"componentChunkName":"component---src-templates-simple-markdown-js","path":"/docs/mcp/best-practices/","matchPath":"","result":{"data":{"markdownRemark":{"html":"

Best Practices

\n

Use a Dedicated Integration User

\n

For any non-personal or production use of the Shipwell MCP Server, create a dedicated integration user in the Shipwell platform rather than using a personal user's API token. This gives you explicit control over what the AI can and cannot do, independent of any individual's account.

\n

Steps

\n

1. Create an integration user in Shipwell

\n

In the Shipwell app, go to Settings → Users and create a new user account specifically for this integration. Use a name that makes the purpose clear, e.g. mcp-integration or ai-agent.

\n

2. Set permissions on that user

\n

Assign the user only the Shipwell platform permissions it needs. The MCP server can only do what the underlying user is permitted to do in the Shipwell app — if the integration user cannot edit shipments, the AI cannot edit them through MCP either.

\n

Start with read-only permissions and only expand them once you are confident in the agent's behavior. See Safety & Write Access for more on dry-run mode and the write access tier.

\n

3. Generate an API token for the integration user

\n

Log in as the integration user and go to Settings → API Management to generate a token.

\n

4. Use that token in your MCP config

\n

Supply the integration user's token in the Authorization header of your MCP server config — not your personal token. See the Quickstart for the config format for each AI client.

\n

Why This Matters

\n","headings":[{"value":"Best Practices","depth":1},{"value":"Use a Dedicated Integration User","depth":2},{"value":"Steps","depth":3},{"value":"Why This Matters","depth":3}]},"contentItem":{"data":{"lastModified":"2026-05-14T19:02:55.000Z","enableToc":null,"disableLastModified":null,"tocMaxDepth":null,"requestLogin":false}},"siteConfig":{"enableToc":true,"disableLastModified":false,"tocMaxDepth":4}},"pageContext":{"matchPath":"","id":"246c0038-049b-5698-b168-4efd926e6c89__redocly content/docs/mcp/best-practices/","seo":{"title":"Best Practices","description":null,"image":"","keywords":null,"jsonLd":null,"lang":null,"siteUrl":null},"pageId":"docs/mcp/best-practices.md","pageBaseUrl":"/docs/mcp/best-practices","type":"markdown","toc":{"enable":true,"maxDepth":4,"headings":[{"depth":1,"value":"Best Practices","id":"best-practices"},{"depth":2,"value":"Use a Dedicated Integration User","id":"use-a-dedicated-integration-user"},{"depth":3,"value":"Steps","id":"steps"},{"depth":3,"value":"Why This Matters","id":"why-this-matters"}]},"data":{"title":""},"catalogInfo":null,"link":"/docs/mcp/best-practices/","sidebarName":"developerPortal","isLanding":false,"showPrevButton":null,"showNextButton":null,"apiVersions":null,"apiVersionId":null,"isDefaultApiVersion":null}},"staticQueryHashes":["1123603147","1302185487","1344209882","1398840060","1520077861","1975142765","2667623876","2950305614","3240152602","3743992808","561138138"]}