typespec-create-api-plugin

为Microsoft 365 Copilot生成包含REST操作、身份验证和自适应卡片的TypeSpec API插件。根据Microsoft 365 Copilot约定，搭建包含代理定义（main.tsp）和API操作（actions.tsp）的完整TypeSpec项目。支持四种身份验证模式：公共API、API密钥标头、OAuth2授权码流程以及注册身份验证引用。包含用于破坏性操作的可选确认对话框以及自适应卡片模板，用于...

Create TypeSpec API Plugin

Create a complete TypeSpec API plugin for Microsoft 365 Copilot that integrates with external REST APIs.

Requirements

Generate TypeSpec files with:

main.tsp - Agent Definition

import "@typespec/http";
import "@typespec/openapi3";
import "@microsoft/typespec-m365-copilot";
import "./actions.tsp";

using TypeSpec.Http;
using TypeSpec.M365.Copilot.Agents;
using TypeSpec.M365.Copilot.Actions;

@agent({
  name: "[Agent Name]",
  description: "[Description]"
})
@instructions("""
  [Instructions for using the API operations]
""")
namespace [AgentName] {
  // Reference operations from actions.tsp
  op operation1 is [APINamespace].operationName;
}

actions.tsp - API Operations

import "@typespec/http";
import "@microsoft/typespec-m365-copilot";

using TypeSpec.Http;
using TypeSpec.M365.Copilot.Actions;

@service
@actions(#{
    nameForHuman: "[API Display Name]",
    descriptionForModel: "[Model description]",
    descriptionForHuman: "[User description]"
})
@server("[API_BASE_URL]", "[API Name]")
@useAuth([AuthType]) // Optional
namespace [APINamespace] {
  
  @route("[/path]")
  @get
  @action
  op operationName(
    @path param1: string,
    @query param2?: string
  ): ResponseModel;

  model ResponseModel {
    // Response structure
  }
}

Authentication Options

Choose based on API requirements:

No Authentication (Public APIs)
```
// No @useAuth decorator needed
```

API Key

@useAuth(ApiKeyAuth<ApiKeyLocation.header, "X-API-Key">)

OAuth2

@useAuth(OAuth2Auth<[{
  type: OAuth2FlowType.authorizationCode;
  authorizationUrl: "https://oauth.example.com/authorize";
  tokenUrl: "https://oauth.example.com/token";
  refreshUrl: "https://oauth.example.com/token";
  scopes: ["read", "write"];
}]>)

Registered Auth Reference

@useAuth(Auth)

@authReferenceId("registration-id-here")
model Auth is ApiKeyAuth<ApiKeyLocation.header, "X-API-Key">

Function Capabilities

Confirmation Dialog

@capabilities(#{
  confirmation: #{
    type: "AdaptiveCard",
    title: "Confirm Action",
    body: """
    Are you sure you want to perform this action?
      * **Parameter**: {{ function.parameters.paramName }}
    """
  }
})

Adaptive Card Response

@card(#{
  dataPath: "$.items",
  title: "$.title",
  url: "$.link",
  file: "cards/card.json"
})

Reasoning & Response Instructions

@reasoning("""
  Consider user's context when calling this operation.
  Prioritize recent items over older ones.
""")
@responding("""
  Present results in a clear table format with columns: ID, Title, Status.
  Include a summary count at the end.
""")

Best Practices

Operation Names: Use clear, action-oriented names (listProjects, createTicket)
Models: Define TypeScript-like models for requests and responses
HTTP Methods: Use appropriate verbs (@get, @post, @patch, @delete)
Paths: Use RESTful path conventions with @route
Parameters: Use @path, @query, @header, @body appropriately
Descriptions: Provide clear descriptions for model understanding
Confirmations: Add for destructive operations (delete, update critical data)
Cards: Use for rich visual responses with multiple data items

Workflow

Ask the user:

What is the API base URL and purpose?
What operations are needed (CRUD operations)?
What authentication method does the API use?
Should confirmations be required for any operations?
Do responses need Adaptive Cards?

Then generate:

Complete main.tsp with agent definition
Complete actions.tsp with API operations and models
Optional cards/card.json if Adaptive Cards are needed