convertkit / includes / mcp / resources / class-convertkit-mcp-resource-overview.php

class-convertkit-mcp-resource-overview.php in Kit (formerly ConvertKit) – Email Newsletter, Email Marketing, Membership, Subscribers and Landing Pages 3.4.3, at includes/mcp/resources/class-convertkit-mcp-resource-overview.php

110 lines 3.4 KB

Raw Download Zip

1	<?php
2	/**
3	* Kit MCP Resource: Overview.
4	*
5	* @package ConvertKit
6	* @author ConvertKit
7	*/
8
9	/**
10	* A Markdown overview of what the Kit Plugin does and how its MCP surface fits
11	* together (`kit://overview`).
12	*
13	* @package ConvertKit
14	* @author ConvertKit
15	*/
16	class ConvertKit_MCP_Resource_Overview extends ConvertKit_MCP_Resource_Reference {
17
18	/**
19	* Returns the resource name.
20	*
21	* @since 3.5.0
22	*
23	* @return string
24	*/
25	public function get_name() {
26
27	return 'kit/overview';
28
29	}
30
31	/**
32	* Returns the resource URI.
33	*
34	* @since 3.5.0
35	*
36	* @return string
37	*/
38	public function get_uri() {
39
40	return 'kit://overview';
41
42	}
43
44	/**
45	* Returns the resource label.
46	*
47	* @since 3.5.0
48	*
49	* @return string
50	*/
51	public function get_label() {
52
53	return __( 'Kit Plugin Overview', 'convertkit' );
54
55	}
56
57	/**
58	* Returns the resource description.
59	*
60	* @since 3.5.0
61	*
62	* @return string
63	*/
64	public function get_description() {
65
66	return __( 'What the Kit WordPress Plugin does and how its MCP tools and resources fit together. Read this first to understand the available concepts.', 'convertkit' );
67
68	}
69
70	/**
71	* Returns the Markdown content lines.
72	*
73	* @since 3.5.0
74	*
75	* @return array
76	*/
77	protected function get_content_lines() {
78
79	return array(
80	'# ' . __( 'Kit WordPress Plugin', 'convertkit' ),
81	'',
82	__( 'The Kit Plugin connects a WordPress site to a Kit (formerly ConvertKit) account, letting the site display Kit Forms and Landing Pages, restrict content to subscribers, and import Kit Broadcasts as posts.', 'convertkit' ),
83	'',
84	'## ' . __( 'Core concepts', 'convertkit' ),
85	'',
86	'- ' . __( 'Forms capture subscribers. They display inline in content, or as a modal / slide in / sticky bar. A default Form can be set per post type, and overridden per post or per category.', 'convertkit' ),
87	'- ' . __( 'Landing Pages are standalone Kit-hosted pages a WordPress page can be set to display.', 'convertkit' ),
88	'- ' . __( 'Tags label subscribers; a post can tag a visitor who is a subscriber.', 'convertkit' ),
89	'- ' . __( 'Products are paid offers used to restrict content to paying subscribers.', 'convertkit' ),
90	'- ' . __( 'Restrict Content gates a post or page behind a Product, Tag or Form.', 'convertkit' ),
91	'- ' . __( 'Broadcasts are Kit emails that can be imported into WordPress as posts.', 'convertkit' ),
92	'',
93	'## ' . __( 'Where settings live', 'convertkit' ),
94	'',
95	'- ' . __( 'General settings control the connection and default Forms per post type.', 'convertkit' ),
96	'- ' . __( 'Per-post settings (`kit/post-settings-*`) set the Form, Landing Page, Tag or Restrict Content rule for a single post or page.', 'convertkit' ),
97	'- ' . __( 'Per-category settings (`kit/category-settings-*`) set a Form for a WordPress category.', 'convertkit' ),
98	'',
99	'## ' . __( 'MCP resources to read for context', 'convertkit' ),
100	'',
101	'- `kit://forms`, `kit://tags`, `kit://landing-pages`, `kit://products` — ' . __( 'current id/name mappings on the connected account. Read these to resolve a name to its numeric ID before configuring settings.', 'convertkit' ),
102	'- `kit://account` — ' . __( 'the connected account.', 'convertkit' ),
103	'- `kit://settings` — ' . __( 'the current Plugin settings.', 'convertkit' ),
104	'- `kit://reference/forms`, `kit://reference/restrict-content`, `kit://reference/settings` — ' . __( 'how those features work.', 'convertkit' ),
105	);
106
107	}
108
109	}
110