mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-03 14:09:24 +00:00
* feat: adopt directory-based docs versioning with Edge channel Switch docs.crewai.com from navigation-only versioning (every version selector entry rendered the same docs/<lang>/* source files) to Mintlify's directory-based versioning so each version selector entry renders its own snapshot. Add an "Edge" channel under docs/edge/<lang>/* that always reflects main HEAD for unreleased work, eliminating pre-release leakage onto frozen release labels. External links to canonical /<lang>/* URLs are preserved via wildcard redirects that always land on the current default version. Layout: - docs/edge/<lang>/* rolling source (you edit here) - docs/edge/enterprise-api.*.yaml - docs/v<X.Y.Z>/<lang>/* frozen, immutable snapshots - docs/v<X.Y.Z>/enterprise-api.*.yaml - docs/images/ shared, append-only - docs/docs.json nav + redirects URLs follow the Mintlify-idiomatic shape: /edge/<lang>/<page> for Edge, /v<X.Y.Z>/<lang>/<page> for every frozen snapshot. The wildcard redirects /<lang>/:slug* -> /<default>/<lang>/:slug* keep stale links working, and every freeze rewrites them (plus all per-section/per-page redirects) so destinations always resolve to the current default without depending on a second redirect hop. Release flow integration (devtools release): - New module crewai_devtools.docs_versioning.freeze() materialises docs/v<X.Y.Z>/ from docs/edge/, rewrites openapi: refs inside the snapshot, inserts the version into every language block in docs.json, and refreshes all redirect destinations. - _update_docs_and_create_pr() in cli.py now calls that freeze during Phase 2 of devtools release. Edge changelogs are updated first (so the snapshot freeze picks them up), then the snapshot is staged alongside docs.json, branched as docs/freeze-v<X.Y.Z>, and the PR is titled [docs-freeze] docs: snapshot and changelog for v<X.Y.Z> — the title prefix the new CI guard reads. - The PR still gates tag, GitHub release, PyPI publish, and the enterprise release as before; no new PRs are added. - Pre-releases (1.X.YaN, 1.X.YbN, ...) skip the snapshot — they ride Edge — and the docs PR title omits the [docs-freeze] prefix. - docs_check (AI-generated docs scaffolding) writes to docs/edge/<lang>/* so newly-generated unreleased docs land in Edge and never accidentally touch a frozen snapshot. Migration scripts (one-shot): - scripts/docs/freeze_historical_versions.py reconstructs all 16 historical snapshots (v1.10.0 .. v1.14.7) from git tags via git archive | tar, rewriting openapi: MDX refs so each snapshot reads its own enterprise-api YAML rather than the live one. - scripts/docs/prefix_version_paths.py one-shot-migrates docs.json: rewrites every page path in 16 versioned blocks to point under docs/v<X.Y.Z>/, inserts a new Edge entry per language, tags v1.14.7 as Latest (default), prunes pages whose target file doesn't exist in the snapshot (e.g. docs/ar/ didn't exist before v1.12.0), and writes the wildcard + per-section redirects. - scripts/docs/freeze_current_edge.py is now a thin CLI wrapper around docs_versioning.freeze for manual one-off freezes (e.g. retroactively snapshotting a forgotten release). CI guards (.github/workflows/docs-snapshots.yml): - Frozen snapshots under docs/v[0-9]*/ are immutable; only PRs whose title contains [docs-freeze] (i.e. release-cut PRs generated by devtools release or the manual wrapper) may modify them. - Images under docs/images/ are append-only since snapshots share a single image directory. Deleting or renaming an image breaks every historical snapshot that still references it. Restored docs/images/crewai-otel-export.png from PR #3673; it was deleted in PR #4908 but v1.10.0 / v1.10.1 snapshots still reference it. Restoring instead of editing the snapshots preserves historical rendering fidelity and validates the new append-only rule retroactively. Tests: - lib/devtools/tests/test_docs_versioning.py covers the freeze: file copy, openapi rewrite, version insertion, default demotion, redirect upserts, per-section redirect rewriting, idempotency, and invalid inputs. Verified locally with mintlify broken-links: 0 broken links across the full site (Edge + 16 frozen versions, 4 locales). AGENTS.md (repo root) is the contributor guide for the new model; RELEASING.md is the release-cut runbook; README's Contribution section links to both. Co-authored-by: Cursor <cursoragent@cursor.com> * style: resolve linter issues --------- Co-authored-by: Cursor <cursoragent@cursor.com>
324 lines
12 KiB
Plaintext
324 lines
12 KiB
Plaintext
---
|
|
title: Microsoft Teams Integration
|
|
description: "Team collaboration and communication with Microsoft Teams integration for CrewAI."
|
|
icon: "users"
|
|
mode: "wide"
|
|
---
|
|
|
|
## Overview
|
|
|
|
Enable your agents to access Teams data, send messages, create meetings, and manage channels. Automate team communication, schedule meetings, retrieve messages, and streamline your collaboration workflows with AI-powered automation.
|
|
|
|
## Prerequisites
|
|
|
|
Before using the Microsoft Teams integration, ensure you have:
|
|
|
|
- A [CrewAI AMP](https://app.crewai.com) account with an active subscription
|
|
- A Microsoft account with Teams access
|
|
- Connected your Microsoft account through the [Integrations page](https://app.crewai.com/crewai_plus/connectors)
|
|
|
|
## Setting Up Microsoft Teams Integration
|
|
|
|
### 1. Connect Your Microsoft Account
|
|
|
|
1. Navigate to [CrewAI AMP Integrations](https://app.crewai.com/crewai_plus/connectors)
|
|
2. Find **Microsoft Teams** in the Authentication Integrations section
|
|
3. Click **Connect** and complete the OAuth flow
|
|
4. Grant the necessary permissions for Teams access
|
|
5. Copy your Enterprise Token from [Integration Settings](https://app.crewai.com/crewai_plus/settings/integrations)
|
|
|
|
### 2. Install Required Package
|
|
|
|
```bash
|
|
uv add crewai-tools
|
|
```
|
|
|
|
### 3. Environment Variable Setup
|
|
|
|
<Note>
|
|
To use integrations with `Agent(apps=[])`, you must set the
|
|
`CREWAI_PLATFORM_INTEGRATION_TOKEN` environment variable with your Enterprise
|
|
Token.
|
|
</Note>
|
|
|
|
```bash
|
|
export CREWAI_PLATFORM_INTEGRATION_TOKEN="your_enterprise_token"
|
|
```
|
|
|
|
Or add it to your `.env` file:
|
|
|
|
```
|
|
CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
|
|
```
|
|
|
|
## Available Actions
|
|
|
|
<AccordionGroup>
|
|
<Accordion title="microsoft_teams/get_teams">
|
|
**Description:** Get all teams the user is a member of.
|
|
|
|
**Parameters:**
|
|
- No parameters required.
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="microsoft_teams/get_channels">
|
|
**Description:** Get channels in a specific team.
|
|
|
|
**Parameters:**
|
|
- `team_id` (string, required): The ID of the team.
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="microsoft_teams/send_message">
|
|
**Description:** Send a message to a Teams channel.
|
|
|
|
**Parameters:**
|
|
- `team_id` (string, required): The ID of the team.
|
|
- `channel_id` (string, required): The ID of the channel.
|
|
- `message` (string, required): The message content.
|
|
- `content_type` (string, optional): Content type (html or text). Enum: `html`, `text`. Default is `text`.
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="microsoft_teams/get_messages">
|
|
**Description:** Get messages from a Teams channel.
|
|
|
|
**Parameters:**
|
|
- `team_id` (string, required): The ID of the team.
|
|
- `channel_id` (string, required): The ID of the channel.
|
|
- `top` (integer, optional): Number of messages to retrieve (max 50). Default is `20`.
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="microsoft_teams/create_meeting">
|
|
**Description:** Create a Teams meeting.
|
|
|
|
**Parameters:**
|
|
- `subject` (string, required): Meeting subject/title.
|
|
- `startDateTime` (string, required): Meeting start time (ISO 8601 format with timezone).
|
|
- `endDateTime` (string, required): Meeting end time (ISO 8601 format with timezone).
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="microsoft_teams/search_online_meetings_by_join_url">
|
|
**Description:** Search online meetings by Join Web URL.
|
|
|
|
**Parameters:**
|
|
- `join_web_url` (string, required): The join web URL of the meeting to search for.
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="microsoft_teams/search_online_meetings_by_meeting_id">
|
|
**Description:** Search online meetings by external Meeting ID.
|
|
|
|
**Parameters:**
|
|
- `join_meeting_id` (string, required): The meeting ID (numeric code) that attendees use to join. This is the joinMeetingId shown in meeting invitations, not the Graph API meeting id.
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="microsoft_teams/get_meeting">
|
|
**Description:** Get details of a specific online meeting.
|
|
|
|
**Parameters:**
|
|
- `meeting_id` (string, required): The Graph API meeting ID (a long alphanumeric string). Obtain from create_meeting or search_online_meetings actions. Different from the numeric joinMeetingId.
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="microsoft_teams/get_team_members">
|
|
**Description:** Get members of a specific team.
|
|
|
|
**Parameters:**
|
|
- `team_id` (string, required): The unique identifier of the team. Obtain from get_teams action.
|
|
- `top` (integer, optional): Maximum number of members to retrieve per page (1-999). Default is `100`.
|
|
- `skip_token` (string, optional): Pagination token from a previous response. When the response includes @odata.nextLink, extract the $skiptoken parameter value and pass it here to get the next page of results.
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="microsoft_teams/create_channel">
|
|
**Description:** Create a new channel in a team.
|
|
|
|
**Parameters:**
|
|
- `team_id` (string, required): The unique identifier of the team. Obtain from get_teams action.
|
|
- `display_name` (string, required): Name of the channel as displayed in Teams. Must be unique within the team. Max 50 characters.
|
|
- `description` (string, optional): Optional description explaining the channel's purpose. Visible in channel details. Max 1024 characters.
|
|
- `membership_type` (string, optional): Channel visibility. Enum: `standard`, `private`. "standard" = visible to all team members, "private" = visible only to specifically added members. Default is `standard`.
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="microsoft_teams/get_message_replies">
|
|
**Description:** Get replies to a specific message in a channel.
|
|
|
|
**Parameters:**
|
|
- `team_id` (string, required): The unique identifier of the team. Obtain from get_teams action.
|
|
- `channel_id` (string, required): The unique identifier of the channel. Obtain from get_channels action.
|
|
- `message_id` (string, required): The unique identifier of the parent message. Obtain from get_messages action.
|
|
- `top` (integer, optional): Maximum number of replies to retrieve per page (1-50). Default is `50`.
|
|
- `skip_token` (string, optional): Pagination token from a previous response. When the response includes @odata.nextLink, extract the $skiptoken parameter value and pass it here to get the next page of results.
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="microsoft_teams/reply_to_message">
|
|
**Description:** Reply to a message in a Teams channel.
|
|
|
|
**Parameters:**
|
|
- `team_id` (string, required): The unique identifier of the team. Obtain from get_teams action.
|
|
- `channel_id` (string, required): The unique identifier of the channel. Obtain from get_channels action.
|
|
- `message_id` (string, required): The unique identifier of the message to reply to. Obtain from get_messages action.
|
|
- `message` (string, required): The reply content. For HTML, include formatting tags. For text, plain text only.
|
|
- `content_type` (string, optional): Content format. Enum: `html`, `text`. "text" for plain text, "html" for rich text with formatting. Default is `text`.
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="microsoft_teams/update_meeting">
|
|
**Description:** Update an existing online meeting.
|
|
|
|
**Parameters:**
|
|
- `meeting_id` (string, required): The unique identifier of the meeting. Obtain from create_meeting or search_online_meetings actions.
|
|
- `subject` (string, optional): New meeting title.
|
|
- `startDateTime` (string, optional): New start time in ISO 8601 format with timezone. Example: "2024-01-20T10:00:00-08:00".
|
|
- `endDateTime` (string, optional): New end time in ISO 8601 format with timezone.
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="microsoft_teams/delete_meeting">
|
|
**Description:** Delete an online meeting.
|
|
|
|
**Parameters:**
|
|
- `meeting_id` (string, required): The unique identifier of the meeting to delete. Obtain from create_meeting or search_online_meetings actions.
|
|
|
|
</Accordion>
|
|
</AccordionGroup>
|
|
|
|
## Usage Examples
|
|
|
|
### Basic Microsoft Teams Agent Setup
|
|
|
|
```python
|
|
from crewai import Agent, Task, Crew
|
|
|
|
# Create an agent with Microsoft Teams capabilities
|
|
teams_agent = Agent(
|
|
role="Teams Coordinator",
|
|
goal="Manage Teams communication and meetings efficiently",
|
|
backstory="An AI assistant specialized in Microsoft Teams operations and team collaboration.",
|
|
apps=['microsoft_teams'] # All Teams actions will be available
|
|
)
|
|
|
|
# Task to list teams and channels
|
|
explore_teams_task = Task(
|
|
description="List all teams I'm a member of and then get the channels for the first team.",
|
|
agent=teams_agent,
|
|
expected_output="List of teams and channels displayed."
|
|
)
|
|
|
|
# Run the task
|
|
crew = Crew(
|
|
agents=[teams_agent],
|
|
tasks=[explore_teams_task]
|
|
)
|
|
|
|
crew.kickoff()
|
|
```
|
|
|
|
### Messaging and Communication
|
|
|
|
```python
|
|
from crewai import Agent, Task, Crew
|
|
|
|
# Create an agent focused on messaging
|
|
messenger = Agent(
|
|
role="Teams Messenger",
|
|
goal="Send and retrieve messages in Teams channels",
|
|
backstory="An AI assistant skilled in team communication and message management.",
|
|
apps=['microsoft_teams/send_message', 'microsoft_teams/get_messages']
|
|
)
|
|
|
|
# Task to send a message and retrieve recent messages
|
|
messaging_task = Task(
|
|
description="Send a message 'Hello team! This is an automated update from our AI assistant.' to the General channel of team 'your_team_id', then retrieve the last 10 messages from that channel.",
|
|
agent=messenger,
|
|
expected_output="Message sent successfully and recent messages retrieved."
|
|
)
|
|
|
|
crew = Crew(
|
|
agents=[messenger],
|
|
tasks=[messaging_task]
|
|
)
|
|
|
|
crew.kickoff()
|
|
```
|
|
|
|
### Meeting Management
|
|
|
|
```python
|
|
from crewai import Agent, Task, Crew
|
|
|
|
# Create an agent for meeting management
|
|
meeting_scheduler = Agent(
|
|
role="Meeting Scheduler",
|
|
goal="Create and manage Teams meetings",
|
|
backstory="An AI assistant that handles meeting scheduling and organization.",
|
|
apps=['microsoft_teams/create_meeting', 'microsoft_teams/search_online_meetings_by_join_url']
|
|
)
|
|
|
|
# Task to create a meeting
|
|
schedule_meeting_task = Task(
|
|
description="Create a Teams meeting titled 'Weekly Team Sync' scheduled for tomorrow at 10:00 AM lasting for 1 hour (use proper ISO 8601 format with timezone).",
|
|
agent=meeting_scheduler,
|
|
expected_output="Teams meeting created successfully with meeting details."
|
|
)
|
|
|
|
crew = Crew(
|
|
agents=[meeting_scheduler],
|
|
tasks=[schedule_meeting_task]
|
|
)
|
|
|
|
crew.kickoff()
|
|
```
|
|
|
|
## Troubleshooting
|
|
|
|
### Common Issues
|
|
|
|
**Authentication Errors**
|
|
|
|
- Ensure your Microsoft account has the necessary permissions for Teams access.
|
|
- Required scopes include: `Team.ReadBasic.All`, `Channel.ReadBasic.All`, `ChannelMessage.Send`, `ChannelMessage.Read.All`, `OnlineMeetings.ReadWrite`, `OnlineMeetings.Read`.
|
|
- Verify that the OAuth connection includes all required scopes.
|
|
|
|
**Team and Channel Access**
|
|
|
|
- Ensure you are a member of the teams you're trying to access.
|
|
- Double-check team IDs and channel IDs for correctness.
|
|
- Team and channel IDs can be obtained using the `get_teams` and `get_channels` actions.
|
|
|
|
**Message Sending Issues**
|
|
|
|
- Ensure `team_id`, `channel_id`, and `message` are provided for `send_message`.
|
|
- Verify that you have permissions to send messages to the specified channel.
|
|
- Choose appropriate `content_type` (text or html) based on your message format.
|
|
|
|
**Meeting Creation**
|
|
|
|
- Ensure `subject`, `startDateTime`, and `endDateTime` are provided.
|
|
- Use proper ISO 8601 format with timezone for datetime fields (e.g., '2024-01-20T10:00:00-08:00').
|
|
- Verify that the meeting times are in the future.
|
|
|
|
**Message Retrieval Limitations**
|
|
|
|
- The `get_messages` action can retrieve a maximum of 50 messages per request.
|
|
- Messages are returned in reverse chronological order (newest first).
|
|
|
|
**Meeting Search**
|
|
|
|
- For `search_online_meetings_by_join_url`, ensure the join URL is exact and properly formatted.
|
|
- The URL should be the complete Teams meeting join URL.
|
|
|
|
### Getting Help
|
|
|
|
<Card title="Need Help?" icon="headset" href="mailto:support@crewai.com">
|
|
Contact our support team for assistance with Microsoft Teams integration setup
|
|
or troubleshooting.
|
|
</Card>
|