Skip to content

post public documentation changes #80

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
shinsi-fathima-rahman merged 1 commit into from
Nov 21, 2025
Merged

post public documentation changes #80

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 31 additions & 31 deletions prompts/Cursor IDE Prompt.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
This guide explains how to use Cursor IDE to create a Microsoft Agent 365 agent by providing a natural language prompt. For illustration, we use **TypeScript with Claude as the orchestrator** and an **email management use case**, but the same approach works for other languages, orchestrators, and scenarios (calendar management, document search, etc.).

You will:
- Attach key GitHub README URLs that describe the Microsoft Agent 365 SDK and your chosen orchestrator (Claude, OpenAI, etc.).
- Send one concise prompt to Cursor so it scaffolds the project for you.
- Reference Microsoft Learn documentation URLs that describe Agent 365 concepts, tooling, and integration patterns.
- Send one concise prompt to Cursor (including documentation URLs) so it scaffolds the project for you.
- Know where to look for the generated README files and next steps.

## 2. Prerequisites
Expand All @@ -16,48 +16,48 @@ Before you begin, make sure you have:
- An idea of the use case you want the agent to support—in this example, summarizing and replying to unread emails.

## 3. Gather References
Cursor gives better results if it has the right references. Add the following GitHub README URLs using Cursor's "Add new doc" feature:

### 3.1 Adding GitHub README URLs
1. In Cursor's chat interface at the bottom, click "@".
2. Click on 'Add new doc'.
3. Paste Microsoft's public URLs—preferably linking directly to README.md files for better indexing. For example, for the agent described in this document, add these GitHub README URLs:
- <https://github.com/microsoft/Agent365-nodejs/blob/main/packages/agents-a365-observability/README.md>
- <https://github.com/microsoft/Agent365-nodejs/blob/main/packages/agents-a365-notifications/README.md>
- <https://github.com/microsoft/Agent365-nodejs/blob/main/packages/agents-a365-runtime/README.md>
- <https://github.com/microsoft/Agent365-nodejs/blob/main/packages/agents-a365-tooling-extensions-claude/README.md>
- <https://github.com/microsoft/Agent365-nodejs/blob/main/packages/agents-a365-tooling/README.md>
- <https://github.com/microsoft/Agent365-Samples/blob/main/nodejs/claude/sample-agent/README.md>
4. Give each URL a descriptive name when prompted (e.g., "Observability", "Runtime", "Claude Tooling", "Sample Agent") so you can reference them easily in prompts.
5. Cursor will fetch and index them. Refer to them in prompts by their names (e.g., `@Observability`, `@Runtime`) or by the full URL (e.g., `@https://...`).

**Tip:** Link directly to README.md files (using `/blob/` URLs) rather than directory pages. This gives Cursor cleaner, more precise content to index. Add only relevant documents. Too many broad references can distract the model. Focus on sections about agent orchestration, tooling, observability, and language-specific setup for the needed orchestrator.
Cursor works best when you reference Microsoft Learn documentation directly in your prompt. You'll include these URLs in your prompt (Section 4), and Cursor will fetch and analyze them in real-time.

When crafting your prompt, reference these Microsoft Learn pages by URL. Cursor will read them when you submit your prompt:

- **Agent 365 Developer Overview**: https://learn.microsoft.com/en-us/microsoft-agent-365/developer/?tabs=nodejs
- **Notifications**: https://learn.microsoft.com/en-us/microsoft-agent-365/developer/notification?tabs=nodejs
- **Tooling (MCP)**: https://learn.microsoft.com/en-us/microsoft-agent-365/developer/tooling?tabs=nodejs
- **Observability**: https://learn.microsoft.com/en-us/microsoft-agent-365/developer/observability?tabs=nodejs
- **Node.js + Claude Quickstart**: https://learn.microsoft.com/en-us/microsoft-agent-365/developer/quickstart-nodejs-claude

## 4. Prompting Cursor
Once your GitHub README URLs are attached, open the Composer and paste a concise prompt like this (already targeting TypeScript):
Open the Composer and paste a prompt like this, including the Microsoft Learn documentation URLs:

```
Using the attached GitHub READMEs, create a Microsoft 365 agent in TypeScript with Claude as the orchestrator that can summarize unread emails and draft helpful email responses. The agent must:
Using these documentations:
https://learn.microsoft.com/en-us/microsoft-agent-365/developer/?tabs=nodejs
https://learn.microsoft.com/en-us/microsoft-agent-365/developer/notification?tabs=nodejs
https://learn.microsoft.com/en-us/microsoft-agent-365/developer/tooling?tabs=nodejs
https://learn.microsoft.com/en-us/microsoft-agent-365/developer/observability?tabs=nodejs
https://learn.microsoft.com/en-us/microsoft-agent-365/developer/quickstart-nodejs-claude

Create a Microsoft Agent 365 agent in TypeScript with Claude as the orchestrator that can summarize unread emails and draft helpful email responses. The agent must:
- Receive a user message
- Forward it to Claude
- Return Claude's response
- Add basic inbound/outbound observability traces
- Integrate tooling support (specifically MailTools for email operations)
Produce the code, config files, and README needed to run it with Node.js/TypeScript.
```
**Note:** You can adapt this prompt for other use cases—replace "summarize unread emails" with "manage calendar events," "search SharePoint documents," or any other scenario. Just mention the relevant tools (CalendarTools, SharePointTools, etc.) in the requirements.
If it misses something—like tooling registration or observability—send a quick follow-up instruction to regenerate the affected files.

**Note:** You can adapt this prompt for other use cases—replace "summarize unread emails" with "manage calendar events," "search SharePoint documents," or other Microsoft 365 operations. Just mention the relevant tools (CalendarTools, SharePointTools, etc.) in the requirements. If it misses something—like tooling registration or observability—send a quick follow-up instruction to regenerate the affected files.

### 4.1 Plan Mode in Cursor
If you want Cursor to show a plan before generating code, switch the Composer into **Plan Mode** (click the lightning icon or toggle labeled “Plan”). After you submit the prompt, Cursor will propose a plan outlining the changes it intends to make. Review it carefully—if it matches your expectations, click **Build** to proceed. You can always edit the plan to suit your requirements.

## 5. Running the Prompt in Cursor
1. Open Cursor and create a new workspace (or use your existing project folder).
2. Ensure the GitHub README URLs are attached in the prompt bar (via "@" → "Add new doc").
3. Open the Composer (click the pencil icon or press `Cmd/Ctrl+L`).
4. Paste the prompt above and submit.
5. Review the generated TypeScript files. Cursor highlights every change so you can confirm the structure looks right.
6. If you need tweaks, send a follow-up instruction (e.g., “Regenerate src/agent.ts with more logging” or “Include a Node.js Express server entry point”).
7. The files are generated directly in your workspace folder and ready to use.
2. Open the Composer (click the pencil icon or press `Cmd/Ctrl+L`).
3. Paste the prompt from Section 4 (including the documentation URLs) and submit.
4. Review the generated TypeScript files. Cursor highlights every change so you can confirm the structure looks right.
5. If you need tweaks, send a follow-up instruction (e.g., "Regenerate src/agent.ts with more logging" or "Include a Node.js Express server entry point").
6. The files are generated directly in your workspace folder and ready to use.

## 6. After Prompt Generation
1. **Read the generated README:** Cursor creates a README with prerequisites, configuration,
Expand All @@ -81,12 +81,12 @@ If you want Cursor to show a plan before generating code, switch the Composer in
- **Calendar management:** "manage calendar events, schedule meetings, and find available time slots" (use CalendarTools)
- **Document search:** "search SharePoint documents and summarize findings" (use SharePointTools)
- Mention the relevant tools in the requirements (e.g., "specifically CalendarTools for calendar operations").
- **Different orchestrator:** Replace "Claude" with another provider (e.g., "OpenAI GPT-4") and attach the relevant docs.
- **Different language:** If you want Python, C#, etc., adjust the prompt accordingly and attach language-specific docs (e.g., Python SDK guides). The rest of this guide still applies, but ensure your documentation references and environment are aligned with that stack.
- **Different orchestrator:** Replace "Claude" with another provider (e.g., "OpenAI GPT-4") and update the documentation URLs to match.
- **Different language:** If you want Python, C#, etc., adjust the prompt and documentation URLs accordingly (change `?tabs=nodejs` to `?tabs=python` or `?tabs=dotnet`). The rest of this guide still applies, but ensure your environment is aligned with that stack.
- **More or less guidance:** Add a sentence if you need something specific (e.g., "Use Express server hosting" or "Skip observability").


By combining your TypeScript-oriented docs with this minimal prompt, Cursor can scaffold a Microsoft Agent 365 project quickly.
By combining Microsoft Learn documentation with this minimal prompt, Cursor can scaffold a Microsoft Agent 365 project quickly.


## Learn More
Expand Down