Create a rule - Context7 MCP

Create a rule

curl --request POST \
  --url https://context7.com/api/v2/teamspaces/{teamspaceId}/rules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "text": "<string>",
  "libraryId": "<string>",
  "docsUrl": "<string>"
}
'

import requests

url = "https://context7.com/api/v2/teamspaces/{teamspaceId}/rules"

payload = {
    "text": "<string>",
    "libraryId": "<string>",
    "docsUrl": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({text: '<string>', libraryId: '<string>', docsUrl: '<string>'})
};

fetch('https://context7.com/api/v2/teamspaces/{teamspaceId}/rules', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://context7.com/api/v2/teamspaces/{teamspaceId}/rules",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'text' => '<string>',
    'libraryId' => '<string>',
    'docsUrl' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://context7.com/api/v2/teamspaces/{teamspaceId}/rules"

	payload := strings.NewReader("{\n  \"text\": \"<string>\",\n  \"libraryId\": \"<string>\",\n  \"docsUrl\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://context7.com/api/v2/teamspaces/{teamspaceId}/rules")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"text\": \"<string>\",\n  \"libraryId\": \"<string>\",\n  \"docsUrl\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://context7.com/api/v2/teamspaces/{teamspaceId}/rules")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"text\": \"<string>\",\n  \"libraryId\": \"<string>\",\n  \"docsUrl\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "text": "<string>",
    "createdBy": "<string>",
    "createdAt": 123,
    "libraryType": "repo",
    "docsUrl": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

POST

/

v2

/

teamspaces

/

{teamspaceId}

/

rules

Create a rule

curl --request POST \
  --url https://context7.com/api/v2/teamspaces/{teamspaceId}/rules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "text": "<string>",
  "libraryId": "<string>",
  "docsUrl": "<string>"
}
'

import requests

url = "https://context7.com/api/v2/teamspaces/{teamspaceId}/rules"

payload = {
    "text": "<string>",
    "libraryId": "<string>",
    "docsUrl": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({text: '<string>', libraryId: '<string>', docsUrl: '<string>'})
};

fetch('https://context7.com/api/v2/teamspaces/{teamspaceId}/rules', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://context7.com/api/v2/teamspaces/{teamspaceId}/rules",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'text' => '<string>',
    'libraryId' => '<string>',
    'docsUrl' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://context7.com/api/v2/teamspaces/{teamspaceId}/rules"

	payload := strings.NewReader("{\n  \"text\": \"<string>\",\n  \"libraryId\": \"<string>\",\n  \"docsUrl\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://context7.com/api/v2/teamspaces/{teamspaceId}/rules")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"text\": \"<string>\",\n  \"libraryId\": \"<string>\",\n  \"docsUrl\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://context7.com/api/v2/teamspaces/{teamspaceId}/rules")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"text\": \"<string>\",\n  \"libraryId\": \"<string>\",\n  \"docsUrl\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "text": "<string>",
    "createdBy": "<string>",
    "createdAt": 123,
    "libraryType": "repo",
    "docsUrl": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

Authorizations

Authorization

string

header

required

Get your API key at context7.com/dashboard. Treat your API key like a password and store it securely. Every key can read the management API (/v2/teamspaces/*), except personal data: member and invitation emails, library requesters, visitor questions, Docs7 reader searches, conversations, feedback and feature requests, and the GitHub account behind a build. To read those or make changes there, the key must be created with Write access ticked; other keys get 403 write_access_required.

Path Parameters

teamspaceId

string<uuid>

required

Teamspace id (from GET /v2/teamspaces).

Body

application/json

text

string

required

Required string length: 1 - 1000

libraryId

string | null

Library id starting with /. Omit or null for a rule on every library.

libraryType

enum<string>

Display hint for the library.

Available options:

repo,

llmstxt,

website,

openapi,

pdf,

docx,

file,

confluence,

notion

docsUrl

string<uri>

http(s) link shown with the library.

Response

Rule created

success

boolean

data

object

Show child attributes