diff --git a/docs/appcircle-ai/_category_.json b/docs/appcircle-ai/_category_.json new file mode 100644 index 000000000..232358290 --- /dev/null +++ b/docs/appcircle-ai/_category_.json @@ -0,0 +1,7 @@ +{ + "label": "Appcircle AI", + "position": 17, + "collapsed": true, + "collapsible": true, + "className": "section-title appcircle-ai" +} diff --git a/docs/marketplace/open-ai/index.md b/docs/appcircle-ai/appcircle-gpt-assistant.md similarity index 56% rename from docs/marketplace/open-ai/index.md rename to docs/appcircle-ai/appcircle-gpt-assistant.md index 11e951748..c0a572fe3 100644 --- a/docs/marketplace/open-ai/index.md +++ b/docs/appcircle-ai/appcircle-gpt-assistant.md @@ -1,31 +1,24 @@ --- -title: OpenAI Marketplace -description: Discover Appcircle Assistant in the OpenAI Marketplace. Get quick answers, step-by-step guidance, and troubleshooting support. -tags: - [ - appcircle assistant, - help, - troubleshooting, - gpt - ] -sidebar_position: 5 +title: Appcircle GPT Assistant +description: Discover and use the Appcircle GPT Assistant for quick answers, step-by-step guidance, and troubleshooting support. +tags: [appcircle ai , gpt, help, troubleshooting] --- import Screenshot from '@site/src/components/Screenshot'; -Appcircle provides a custom **Appcircle Assistant** GPT designed to deliver quick and clear answers, offering step-by-step guidance and troubleshooting support for users. +Appcircle provides a custom **Appcircle GPT Assistant** designed to deliver quick and clear answers, offering step-by-step guidance and troubleshooting support for users. https://chatgpt.com/g/g-686e31aa891481919ef3603325b15ae0-appcircle-assistant -### How to Use Appcircle Assistant +### How to Use Appcircle GPT Assistant -Getting started with the Appcircle Assistant is simple. Just follow these steps: +Getting started with the Appcircle GPT Assistant is simple. Just follow these steps: 1. Log in to your [ChatGPT account](https://chatgpt.com/). 2. In the left-hand menu, click **GPTs**. 3. Use the search bar to type **Appcircle Assistant**. -4. Click on it to open and start your conversation with the **Appcircle Assistant**. - \ No newline at end of file +4. Click on it to open and start your conversation with the **Appcircle GPT Assistant**. + diff --git a/docs/appcircle-ai/appcircle-mcp-server.md b/docs/appcircle-ai/appcircle-mcp-server.md new file mode 100644 index 000000000..8fe2e0e09 --- /dev/null +++ b/docs/appcircle-ai/appcircle-mcp-server.md @@ -0,0 +1,148 @@ +--- +title: Appcircle MCP Server +description: Learn how to use the Appcircle MCP (Model Context Protocol) server to integrate Appcircle with AI-powered development tools. +tags: [appcircle mcp, mcp server, model context protocol, ai, integration] +sidebar_position: 2 +--- + +import ContentRef from '@site/src/components/ContentRef'; +import Screenshot from '@site/src/components/Screenshot'; + +# Appcircle MCP Server + +The Appcircle MCP Server exposes Appcircle platform capabilities through the Model Context Protocol (MCP), enabling AI assistants and development tools to interact with your Appcircle organization, builds, and workflows directly from your IDE or CLI. + +:::tip What is MCP? +The [Model Context Protocol](https://modelcontextprotocol.io/) is an open protocol that lets AI models securely connect to external tools and data sources. The Appcircle MCP server allows AI tools to connect Appcircle resources. +::: + +https://github.com/appcircleio/appcircle-mcp + +## How MCP works + +The Appcircle MCP Server acts as a bridge between MCP-capable clients (such as Claude Applications, Codex, Cursor, or VS Code) and the Appcircle platform. Your AI assistant sends requests through the client; the client talks to the MCP server; the server calls Appcircle's APIs and returns structured data. This lets you query builds, profiles, signing identities, distribution status, publish status, and reports using natural language or tool call. + +### Use cases + +- **CI/CD and workflow intelligence**: Monitor pipeline runs, track release status, and get insights into your mobile CI/CD workflows. +- **Configuration and environment insights**: Query build configurations and signing setup to understand how a project is configured and where issues may originate. +- **Reporting and operational insights**: Generate summaries of CI stability, recurring issues, pipeline performance, and overall CI/CD health and more. + +### Toolsets + +The server exposes the following toolsets. Each toolset groups related tools (for example, listing build profiles, getting workflow details, or fetching reports). + +| Toolset | Description | +|---------|-------------| +| `build_module` | Build profiles, configurations, workflows, commits, and pipeline operations | +| `signing_identities` | Signing Identities: certificates, bundle identifiers, keystores | +| `testing_distribution` | Testing distribution profiles and distribution details | +| `publish_to_stores` | Publish profiles and store publishing operations | +| `enterprise_app_store` | Enterprise app store profiles and store details | +| `report` | Reporting: build history, distribution, signing, publish status, and related reports | + +You can exclude one or more toolsets when running the server (via environment variable or CLI) so that only the tools you need are exposed. See how you can [exclude toolsets](https://github.com/appcircleio/appcircle-mcp?tab=readme-ov-file#toolsets). + +### Tools + +#### Build + +| Tool | Description | Permission | +|------|-------------|------------| +| `get_build_profiles` | List build profiles for the current organization (paginated), excluding sensitive profile keys. | Viewer | +| `get_build_profile_details` | Get details for a single build profile, optionally including its build configurations. | Viewer | +| `get_build_configuration_details` | Get details for a single build configuration under a given build profile. | Viewer | +| `get_build_profile_workflows` | List workflows associated with a build profile. | Viewer | +| `get_workflow_detail` | Get details and YAML definition for a single workflow in a build profile. | Viewer | +| `get_commits_by_branch` | List commits for a build branch, with optional pagination metadata. | Viewer | +| `get_commit_details` | Get detailed information for a single commit by ID or commit hash. | Viewer | + +#### Signing Identities + +| Tool | Description | Permission | +|------|-------------|------------| +| `get_bundle_identifiers` | List bundle identifiers (iOS/macOS app bundle IDs) registered in Appcircle. | Viewer | +| `get_certificates` | List signing certificates for the organization, omitting sensitive fields. | Viewer | +| `get_keystores` | List keystores (e.g. Android signing keystores), omitting sensitive fields. | Viewer | +| `get_provisioning_profiles` | List provisioning profiles, optionally filtered by app/bundle ID, omitting sensitive fields. | Viewer | + +#### Testing Distribution + +| Tool | Description | Permission | +|------|-------------|------------| +| `get_distribution_profiles` | List testing distribution profiles for the current organization (paginated), omitting sensitive settings. | Viewer | +| `get_distribution_profile_details` | Get details for a single distribution profile, including paginated app versions, omitting sensitive settings. | Viewer | + +#### Publish to Stores + +| Tool | Description | Permission | +|------|-------------|------------| +| `get_publish_profiles` | List publish profiles for a given platform (iOS/Android), with pagination and optional flow-status filtering. | Viewer | +| `get_publish_profile_details` | Get details for a single publish profile (iOS/Android), including paginated app versions, omitting certificate thumbprints. | Viewer | + +#### Enterprise App Store + +| Tool | Description | Permission | +|------|-------------|------------| +| `get_store_profiles` | List enterprise app store profiles for the current organization (paginated). | Viewer | +| `get_store_profile_details` | Get details for a single enterprise app store profile, including paginated app versions, omitting certificate thumbprints. | Viewer | + +#### Report + +| Tool | Description | Permission | +|------|-------------|------------| +| `get_build_history_report` | Get build history report with pagination and optional filters (date range, build profile, organization). | Viewer | +| `get_signing_report` | Get signing report with pagination and optional filters (date range, organization, OS, build status). | Viewer | +| `get_distribution_app_version_report` | Get daily usage report for distributed app versions with pagination and filters (date range, profile, OS, organization). | Viewer | +| `get_distribution_sent_report` | Get daily usage report for distributed app sharing with pagination and filters (date range, profile, OS, organization). | Viewer | +| `get_enterprise_app_store_app_usage_report` | Get app usage report for the enterprise app store with pagination and optional organization filter. | Viewer | +| `get_publish_status_report` | Get publish status report with pagination and optional filters (date range, app name, organization, status). | Viewer | +| `get_publish_resign_report` | Get publish resign report with pagination and optional filters (date range, app name, organization, status). | Viewer | + +## Supported Clients + +The Appcircle MCP Server works with any MCP-capable client. Installation and client-specific setup (including how to add the server and configure your token) are documented in the [Installation Guides](https://github.com/appcircleio/appcircle-mcp/tree/main/docs/installation_guides). + +- [**Claude Applications** (Claude Desktop, Claude Code)](https://github.com/appcircleio/appcircle-mcp/blob/main/docs/installation_guides/claude_applications.md) +- [**Cursor IDE**](https://github.com/appcircleio/appcircle-mcp/blob/main/docs/installation_guides/cursor.md) +- [**Codex** (App and CLI)](https://github.com/appcircleio/appcircle-mcp/blob/main/docs/installation_guides/codex.md) +- [**Antigravity IDE**](https://github.com/appcircleio/appcircle-mcp/blob/main/docs/installation_guides/antigravity.md) +- [**VS Code** (GitHub Copilot)](https://github.com/appcircleio/appcircle-mcp/blob/main/docs/installation_guides/vscode.md) +- [**Windsurf IDE**](https://github.com/appcircleio/appcircle-mcp/blob/main/docs/installation_guides/windsurf.md) +- [**Gemini CLI**](https://github.com/appcircleio/appcircle-mcp/blob/main/docs/installation_guides/gemini_cli.md) +- [**GitHub Copilot CLI**](https://github.com/appcircleio/appcircle-mcp/blob/main/docs/installation_guides/copilot_cli.md) + +Follow the guide for your client to install or connect to the Appcircle MCP Server and to set your Appcircle access token. + +You can see the available tools in your MCP client after the Appcircle MCP server is configured. The client lists the tools the server provides; you or the AI can then call them to fetch Build profiles, distribution details, reports, and more. + + + +## Authentication + +To use the Appcircle MCP Server, you need an **Appcircle Access Token**. This token authenticates requests to Appcircle's APIs and is required for all running modes (stdio, streamable-http, or when connecting to the remote host at `https://mcp.appcircle.io`). + +There are **two ways** to obtain an access token. For step-by-step instructions on creating and exchanging credentials for a token: + +1. [Personal Access Key](/account/my-organization/security/personal-access-key): Best for individual use; inherits your user permissions in the organization. +2. [API Keys](/account/my-organization/security/api-keys): Best for automation and CI; scoped by organization and roles. + +Both produce an access token that you use as `APPCIRCLE_ACCESS_TOKEN` in your environment or pass via your MCP client (for example, `Authorization: Bearer `). + +:::warning Restrict write access when possible +When creating the token (either method), **restrict write access** if you only need read-only MCP usage. For example, listing Build profiles, Distribution profiles, or Reports. Grant write permissions only when you want the AI or your client to trigger builds or change settings. For **API Keys**, use **Viewer** (or read-only) roles for the relevant modules. For **Personal Access Key**, your user role in the organization applies; use an account or role with read-only access if you do not need write operations. +::: + +## FAQ + +### Do I need write access to use the Appcircle MCP? + +No. Read-only access is enough for listing builds, profiles, and reports. Grant write access only if you want the AI or your client to trigger builds or change settings. When creating an API Key, use Viewer (or read-only) roles for the relevant modules. When using a Personal Access Key, your user role in the organization applies. + +### Do I need to install the Appcircle MCP server locally? + +No. You can connect to the **remote host** at `https://mcp.appcircle.io` and send your Appcircle token with each request; no local install is required. If you prefer to run the server locally (stdio, streamable-http, or Docker), see the [documentation](https://github.com/appcircleio/appcircle-mcp?tab=readme-ov-file#appcircle-mcp-server) for running modes and client configuration. + +### Where do I find installation steps for my Appcircle MCP client? + +Client-specific installation and setup guides are in the [Installation Guides](https://github.com/appcircleio/appcircle-mcp#installation). Follow the guide for your client (Claude, Cursor, Codex, VS Code, etc.) to add the Appcircle MCP Server and configure your token. \ No newline at end of file diff --git a/docs/appcircle-ai/index.md b/docs/appcircle-ai/index.md new file mode 100644 index 000000000..ebe8751d9 --- /dev/null +++ b/docs/appcircle-ai/index.md @@ -0,0 +1,24 @@ +--- +title: Appcircle AI +description: Explore AI-powered Appcircle and all AI-related features. +tags: [appcircle ai, mcp, model context protocol, ai] +sidebar_position: 1 +--- + +import ContentRef from '@site/src/components/ContentRef'; + +# Appcircle AI + +Explore AI-powered Appcircle and all AI-related features. This section covers integrating with AI assistants and development tools and leveraging the platform for smarter builds and workflows. + +## [Appcircle MCP Server](/appcircle-ai/appcircle-mcp-server) + +The Appcircle MCP Server exposes Appcircle platform capabilities through the Model Context Protocol (MCP), enabling AI assistants and development tools to interact with your Appcircle organization, builds, and workflows directly from your IDE or CLI. + +Appcircle MCP Server + +## [Appcircle GPT Assistant](/appcircle-ai/appcircle-gpt-assistant) + +Use the Appcircle GPT Assistant in the OpenAI Marketplace for quick answers, step-by-step guidance, and troubleshooting support. + +Appcircle GPT Assistant diff --git a/docs/best-practices/_category_.json b/docs/best-practices/_category_.json index 1b1fe7135..7682cb759 100644 --- a/docs/best-practices/_category_.json +++ b/docs/best-practices/_category_.json @@ -1,6 +1,6 @@ { "label": "Best Practices", - "position": 19, + "position": 20, "collapsed": true, "collapsible": true, "className": "section-title best-practices" diff --git a/docs/marketplace/_category_.json b/docs/marketplace/_category_.json index 3336c4619..acfec3cd2 100644 --- a/docs/marketplace/_category_.json +++ b/docs/marketplace/_category_.json @@ -1,6 +1,6 @@ { "label": "Marketplace", - "position": 18, + "position": 19, "collapsed": true, "collapsible": true, "className": "section-title marketplace" diff --git a/docs/marketplace/index.md b/docs/marketplace/index.md index 7cf160cb8..9fd29ef5c 100644 --- a/docs/marketplace/index.md +++ b/docs/marketplace/index.md @@ -25,7 +25,3 @@ Leverage Testing Distribution to efficiently distribute test builds to specific ## [Visual Studio Marketplace](/marketplace/visual-studio-marketplace) Appcircle offers two extensions: "Testing Distribution" and "Enterprise App Store". These help users distribute builds to test groups, individuals, or for beta testing. - -## [OpenAI Marketplace](/marketplace/open-ai) - -Appcircle offers a custom Assistant GPT that provides users with quick, clear answers about Appcircle, including step-by-step instructions and troubleshooting support. diff --git a/docs/release-notes.md b/docs/release-notes.md index c95cb205f..3c3618a24 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -495,7 +495,7 @@ You cannot upgrade directly from `3.28.3` or an older version to `3.29.3` or lat - Support for the [GitHub Enterprise](build/manage-the-connections/connection-guides/connecting-to-github) connection type has been added to allow build profiles to connect to repositories using a Fine-Grained Personal Access Token. - Introduced dynamic [SMTP configuration](self-hosted-appcircle/install-server/linux-package/configure-server/integrations-and-access/integration#email) for self-hosted environments, including live updates to mail server settings, and test email functionality. -- Introduced the [Appcircle Assistant GPT](/marketplace/open-ai), a custom AI assistant that provides answers about Appcircle, including step-by-step instructions and troubleshooting support. +- Introduced the [Appcircle Assistant GPT](/appcircle-ai/appcircle-gpt-assistant.md), a custom AI assistant that provides answers about Appcircle, including step-by-step instructions and troubleshooting support. ### :muscle: Improvements diff --git a/docs/self-hosted-appcircle/_category_.json b/docs/self-hosted-appcircle/_category_.json index 954c33402..bf91c2521 100644 --- a/docs/self-hosted-appcircle/_category_.json +++ b/docs/self-hosted-appcircle/_category_.json @@ -1,6 +1,6 @@ { "label": "Self-Hosted Appcircle", - "position": 17, + "position": 18, "collapsed": true, "collapsible": true, "className": "section-title self-hosted" diff --git a/docs/tags.yml b/docs/tags.yml index d32013cd4..98385888a 100644 --- a/docs/tags.yml +++ b/docs/tags.yml @@ -283,11 +283,21 @@ appcircle: description: "Description for appcircle app store" permalink: /appcircle-app-store +appcircle ai: + label: "appcircle ai" + description: "Documentation related to Appcircle AI" + permalink: /appcircle-ai + "appcircle assistant": label: "appcircle assistant" description: "Description for appcircle assistant" permalink: /appcircle-assistant +"appcircle mcp": + label: "appcircle mcp" + description: "Documentation related to the Appcircle MCP server" + permalink: /appcircle-mcp + "appcircle bot": label: "appcircle bot" description: "Description for appcircle bot" @@ -1358,6 +1368,11 @@ gitlab: description: "Description for google play service account" permalink: /google-play-service-account +ai: + label: "ai" + description: "Documentation related to AI features and capabilities" + permalink: /ai + gpt: label: "gpt" description: "Description for gpt" @@ -2923,6 +2938,21 @@ xml: description: "Description for xml" permalink: /xml +mcp: + label: "mcp" + description: "Documentation related to the Model Context Protocol (MCP)" + permalink: /mcp + +"model context protocol": + label: "model context protocol" + description: "Documentation related to the Model Context Protocol (MCP)" + permalink: /model-context-protocol + +"mcp server": + label: "mcp server" + description: "Documentation related to the MCP server" + permalink: /mcp-server + "ci/cd": label: "ci/cd" description: "Description for ci/cd" diff --git a/netlify.toml b/netlify.toml index a2149c0ba..350b50724 100644 --- a/netlify.toml +++ b/netlify.toml @@ -873,6 +873,11 @@ from = "/integrations/workflow-marketplace" to = "/build/build-process-management/build-workflows" status = 301 +[[redirects]] +from = "/marketplace/open-ai" +to = "/appcircle-ai/appcircle-gpt-assistant" +status = 301 + [[redirects]] from = "/integrations/deploying-web-apps-to-aws-amplify-console" to = "/workflows/flutter-specific-workflow-steps/flutter-build-for-web" diff --git a/src/css/custom.css b/src/css/custom.css index f05eb55bd..e401bf02e 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -1047,6 +1047,10 @@ button[class*='toggleButton']:hover svg[class*='lightToggleIcon'] path { background-image: url(../../static/img/sidebar/best-practices.svg); } +.section-title.appcircle-ai > div >a::before { + background-image: url(../../static/img/sidebar/appcircle-ai.svg); +} + .hidden { display: none !important; } diff --git a/static/img/sidebar/appcircle-ai.svg b/static/img/sidebar/appcircle-ai.svg new file mode 100644 index 000000000..81c11e803 --- /dev/null +++ b/static/img/sidebar/appcircle-ai.svg @@ -0,0 +1,34 @@ + + + + + + + + + + + + + + \ No newline at end of file